diff options
Diffstat (limited to 'src/lib/libcrypto/doc/EVP_SignInit.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/EVP_SignInit.pod | 96 |
1 files changed, 0 insertions, 96 deletions
diff --git a/src/lib/libcrypto/doc/EVP_SignInit.pod b/src/lib/libcrypto/doc/EVP_SignInit.pod deleted file mode 100644 index e65e54ce52..0000000000 --- a/src/lib/libcrypto/doc/EVP_SignInit.pod +++ /dev/null | |||
| @@ -1,96 +0,0 @@ | |||
| 1 | =pod | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | EVP_SignInit, EVP_SignUpdate, EVP_SignFinal - EVP signing functions | ||
| 6 | |||
| 7 | =head1 SYNOPSIS | ||
| 8 | |||
| 9 | #include <openssl/evp.h> | ||
| 10 | |||
| 11 | int EVP_SignInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl); | ||
| 12 | int EVP_SignUpdate(EVP_MD_CTX *ctx, const void *d, unsigned int cnt); | ||
| 13 | int EVP_SignFinal(EVP_MD_CTX *ctx,unsigned char *sig,unsigned int *s, EVP_PKEY *pkey); | ||
| 14 | |||
| 15 | void EVP_SignInit(EVP_MD_CTX *ctx, const EVP_MD *type); | ||
| 16 | |||
| 17 | int EVP_PKEY_size(EVP_PKEY *pkey); | ||
| 18 | |||
| 19 | =head1 DESCRIPTION | ||
| 20 | |||
| 21 | The EVP signature routines are a high level interface to digital | ||
| 22 | signatures. | ||
| 23 | |||
| 24 | EVP_SignInit_ex() sets up signing context B<ctx> to use digest | ||
| 25 | B<type> from ENGINE B<impl>. B<ctx> must be initialized with | ||
| 26 | EVP_MD_CTX_init() before calling this function. | ||
| 27 | |||
| 28 | EVP_SignUpdate() hashes B<cnt> bytes of data at B<d> into the | ||
| 29 | signature context B<ctx>. This function can be called several times on the | ||
| 30 | same B<ctx> to include additional data. | ||
| 31 | |||
| 32 | EVP_SignFinal() signs the data in B<ctx> using the private key B<pkey> | ||
| 33 | and places the signature in B<sig>. If the B<s> parameter is not NULL | ||
| 34 | then the number of bytes of data written (i.e. the length of the signature) | ||
| 35 | will be written to the integer at B<s>, at most EVP_PKEY_size(pkey) bytes | ||
| 36 | will be written. | ||
| 37 | |||
| 38 | EVP_SignInit() initializes a signing context B<ctx> to use the default | ||
| 39 | implementation of digest B<type>. | ||
| 40 | |||
| 41 | EVP_PKEY_size() returns the maximum size of a signature in bytes. The actual | ||
| 42 | signature returned by EVP_SignFinal() may be smaller. | ||
| 43 | |||
| 44 | =head1 RETURN VALUES | ||
| 45 | |||
| 46 | EVP_SignInit_ex(), EVP_SignUpdate() and EVP_SignFinal() return 1 | ||
| 47 | for success and 0 for failure. | ||
| 48 | |||
| 49 | EVP_PKEY_size() returns the maximum size of a signature in bytes. | ||
| 50 | |||
| 51 | The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. | ||
| 52 | |||
| 53 | =head1 NOTES | ||
| 54 | |||
| 55 | The B<EVP> interface to digital signatures should almost always be used in | ||
| 56 | preference to the low level interfaces. This is because the code then becomes | ||
| 57 | transparent to the algorithm used and much more flexible. | ||
| 58 | |||
| 59 | Due to the link between message digests and public key algorithms the correct | ||
| 60 | digest algorithm must be used with the correct public key type. A list of | ||
| 61 | algorithms and associated public key algorithms appears in | ||
| 62 | L<EVP_DigestInit(3)|EVP_DigestInit(3)>. | ||
| 63 | |||
| 64 | When signing with DSA private keys the random number generator must be seeded | ||
| 65 | or the operation will fail. The random number generator does not need to be | ||
| 66 | seeded for RSA signatures. | ||
| 67 | |||
| 68 | The call to EVP_SignFinal() internally finalizes a copy of the digest context. | ||
| 69 | This means that calls to EVP_SignUpdate() and EVP_SignFinal() can be called | ||
| 70 | later to digest and sign additional data. | ||
| 71 | |||
| 72 | Since only a copy of the digest context is ever finalized the context must | ||
| 73 | be cleaned up after use by calling EVP_MD_CTX_cleanup() or a memory leak | ||
| 74 | will occur. | ||
| 75 | |||
| 76 | =head1 BUGS | ||
| 77 | |||
| 78 | Older versions of this documentation wrongly stated that calls to | ||
| 79 | EVP_SignUpdate() could not be made after calling EVP_SignFinal(). | ||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | L<EVP_VerifyInit(3)|EVP_VerifyInit(3)>, | ||
| 84 | L<EVP_DigestInit(3)|EVP_DigestInit(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, | ||
| 85 | L<evp(3)|evp(3)>, L<HMAC(3)|HMAC(3)>, L<MD2(3)|MD2(3)>, | ||
| 86 | L<MD5(3)|MD5(3)>, L<MDC2(3)|MDC2(3)>, L<RIPEMD(3)|RIPEMD(3)>, | ||
| 87 | L<SHA1(3)|SHA1(3)>, L<digest(1)|digest(1)> | ||
| 88 | |||
| 89 | =head1 HISTORY | ||
| 90 | |||
| 91 | EVP_SignInit(), EVP_SignUpdate() and EVP_SignFinal() are | ||
| 92 | available in all versions of SSLeay and OpenSSL. | ||
| 93 | |||
| 94 | EVP_SignInit_ex() was added in OpenSSL 0.9.7. | ||
| 95 | |||
| 96 | =cut | ||
