diff options
author | schwarze <> | 2015-11-11 18:36:48 +0000 |
---|---|---|
committer | schwarze <> | 2015-11-11 18:36:48 +0000 |
commit | 0241f6701aac0e95428b9f0899b07ba086aa7e71 (patch) | |
tree | 80b2aab86130838808328db62934a4188f195886 /src/lib/libssl | |
parent | d5282d754e743726bcafb49d0992917dc89caf2b (diff) | |
download | openbsd-0241f6701aac0e95428b9f0899b07ba086aa7e71.tar.gz openbsd-0241f6701aac0e95428b9f0899b07ba086aa7e71.tar.bz2 openbsd-0241f6701aac0e95428b9f0899b07ba086aa7e71.zip |
Convert and enable CMS manuals.
Already some time ago, bcook@ said these can be installed.
Diffstat (limited to 'src/lib/libssl')
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_add0_cert.pod | 67 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_add1_recipient_cert.pod | 63 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_compress.pod | 73 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_decrypt.pod | 79 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_encrypt.pod | 93 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_final.pod | 41 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_get0_RecipientInfos.pod | 111 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_get0_SignerInfos.pod | 76 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_get0_type.pod | 64 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_get1_ReceiptRequest.pod | 70 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_sign.pod | 122 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_sign_add1_signer.pod | 103 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_sign_receipt.pod | 45 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_uncompress.pod | 54 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_verify.pod | 126 | ||||
-rw-r--r-- | src/lib/libssl/src/doc/crypto/CMS_verify_receipt.pod | 47 |
16 files changed, 0 insertions, 1234 deletions
diff --git a/src/lib/libssl/src/doc/crypto/CMS_add0_cert.pod b/src/lib/libssl/src/doc/crypto/CMS_add0_cert.pod deleted file mode 100644 index b289237ec2..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_add0_cert.pod +++ /dev/null | |||
@@ -1,67 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_add0_cert, CMS_add1_cert, CMS_get1_certs, CMS_add0_crl, CMS_add1_crl, | ||
6 | CMS_get1_crls - CMS certificate and CRL utility functions | ||
7 | |||
8 | =head1 SYNOPSIS | ||
9 | |||
10 | #include <openssl/cms.h> | ||
11 | |||
12 | int CMS_add0_cert(CMS_ContentInfo *cms, X509 *cert); | ||
13 | int CMS_add1_cert(CMS_ContentInfo *cms, X509 *cert); | ||
14 | STACK_OF(X509) *CMS_get1_certs(CMS_ContentInfo *cms); | ||
15 | |||
16 | int CMS_add0_crl(CMS_ContentInfo *cms, X509_CRL *crl); | ||
17 | int CMS_add1_crl(CMS_ContentInfo *cms, X509_CRL *crl); | ||
18 | STACK_OF(X509_CRL) *CMS_get1_crls(CMS_ContentInfo *cms); | ||
19 | |||
20 | |||
21 | =head1 DESCRIPTION | ||
22 | |||
23 | CMS_add0_cert() and CMS_add1_cert() add certificate B<cert> to B<cms>. | ||
24 | must be of type signed data or enveloped data. | ||
25 | |||
26 | CMS_get1_certs() returns all certificates in B<cms>. | ||
27 | |||
28 | CMS_add0_crl() and CMS_add1_crl() add CRL B<crl> to B<cms>. CMS_get1_crls() | ||
29 | returns any CRLs in B<cms>. | ||
30 | |||
31 | =head1 NOTES | ||
32 | |||
33 | The CMS_ContentInfo structure B<cms> must be of type signed data or enveloped | ||
34 | data or an error will be returned. | ||
35 | |||
36 | For signed data certificates and CRLs are added to the B<certificates> and | ||
37 | B<crls> fields of SignedData structure. For enveloped data they are added to | ||
38 | B<OriginatorInfo>. | ||
39 | |||
40 | As the B<0> implies CMS_add0_cert() adds B<cert> internally to B<cms> and it | ||
41 | must not be freed up after the call as opposed to CMS_add1_cert() where B<cert> | ||
42 | must be freed up. | ||
43 | |||
44 | The same certificate or CRL must not be added to the same cms structure more | ||
45 | than once. | ||
46 | |||
47 | =head1 RETURN VALUES | ||
48 | |||
49 | CMS_add0_cert(), CMS_add1_cert() and CMS_add0_crl() and CMS_add1_crl() return | ||
50 | 1 for success and 0 for failure. | ||
51 | |||
52 | CMS_get1_certs() and CMS_get1_crls() return the STACK of certificates or CRLs | ||
53 | or NULL if there are none or an error occurs. The only error which will occur | ||
54 | in practice is if the B<cms> type is invalid. | ||
55 | |||
56 | =head1 SEE ALSO | ||
57 | |||
58 | L<ERR_get_error(3)|ERR_get_error(3)>, | ||
59 | L<CMS_sign(3)|CMS_sign(3)>, | ||
60 | L<CMS_encrypt(3)|CMS_encrypt(3)> | ||
61 | |||
62 | =head1 HISTORY | ||
63 | |||
64 | CMS_add0_cert(), CMS_add1_cert(), CMS_get1_certs(), CMS_add0_crl() | ||
65 | and CMS_get1_crls() were all first added to OpenSSL 0.9.8 | ||
66 | |||
67 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_add1_recipient_cert.pod b/src/lib/libssl/src/doc/crypto/CMS_add1_recipient_cert.pod deleted file mode 100644 index 8a39391aa4..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_add1_recipient_cert.pod +++ /dev/null | |||
@@ -1,63 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_add1_recipient_cert, CMS_add0_recipient_key - add recipients to a CMS | ||
6 | enveloped data structure | ||
7 | |||
8 | =head1 SYNOPSIS | ||
9 | |||
10 | #include <openssl/cms.h> | ||
11 | |||
12 | CMS_RecipientInfo *CMS_add1_recipient_cert(CMS_ContentInfo *cms, X509 *recip, unsigned int flags); | ||
13 | |||
14 | CMS_RecipientInfo *CMS_add0_recipient_key(CMS_ContentInfo *cms, int nid, unsigned char *key, size_t keylen, unsigned char *id, size_t idlen, ASN1_GENERALIZEDTIME *date, ASN1_OBJECT *otherTypeId, ASN1_TYPE *otherType); | ||
15 | |||
16 | =head1 DESCRIPTION | ||
17 | |||
18 | CMS_add1_recipient_cert() adds recipient B<recip> to CMS_ContentInfo enveloped | ||
19 | data structure B<cms> as a KeyTransRecipientInfo structure. | ||
20 | |||
21 | CMS_add0_recipient_key() adds symmetric key B<key> of length B<keylen> using | ||
22 | wrapping algorithm B<nid>, identifier B<id> of length B<idlen> and optional | ||
23 | values B<date>, B<otherTypeId> and B<otherType> to CMS_ContentInfo enveloped | ||
24 | data structure B<cms> as a KEKRecipientInfo structure. | ||
25 | |||
26 | The CMS_ContentInfo structure should be obtained from an initial call to | ||
27 | CMS_encrypt() with the flag B<CMS_PARTIAL> set. | ||
28 | |||
29 | =head1 NOTES | ||
30 | |||
31 | The main purpose of this function is to provide finer control over a CMS | ||
32 | enveloped data structure where the simpler CMS_encrypt() function defaults are | ||
33 | not appropriate. For example if one or more KEKRecipientInfo structures | ||
34 | need to be added. New attributes can also be added using the returned | ||
35 | CMS_RecipientInfo structure and the CMS attribute utility functions. | ||
36 | |||
37 | OpenSSL will by default identify recipient certificates using issuer name | ||
38 | and serial number. If B<CMS_USE_KEYID> is set it will use the subject key | ||
39 | identifier value instead. An error occurs if all recipient certificates do not | ||
40 | have a subject key identifier extension. | ||
41 | |||
42 | Currently only AES based key wrapping algorithms are supported for B<nid>, | ||
43 | specifically: NID_id_aes128_wrap, NID_id_aes192_wrap and NID_id_aes256_wrap. | ||
44 | If B<nid> is set to B<NID_undef> then an AES wrap algorithm will be used | ||
45 | consistent with B<keylen>. | ||
46 | |||
47 | =head1 RETURN VALUES | ||
48 | |||
49 | CMS_add1_recipient_cert() and CMS_add0_recipient_key() return an internal | ||
50 | pointer to the CMS_RecipientInfo structure just added or NULL if an error | ||
51 | occurs. | ||
52 | |||
53 | =head1 SEE ALSO | ||
54 | |||
55 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_decrypt(3)|CMS_decrypt(3)>, | ||
56 | L<CMS_final(3)|CMS_final(3)>, | ||
57 | |||
58 | =head1 HISTORY | ||
59 | |||
60 | CMS_add1_recipient_cert() and CMS_add0_recipient_key() were added to OpenSSL | ||
61 | 0.9.8 | ||
62 | |||
63 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_compress.pod b/src/lib/libssl/src/doc/crypto/CMS_compress.pod deleted file mode 100644 index 0a0715271d..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_compress.pod +++ /dev/null | |||
@@ -1,73 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_compress - create a CMS CompressedData structure | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/cms.h> | ||
10 | |||
11 | CMS_ContentInfo *CMS_compress(BIO *in, int comp_nid, unsigned int flags); | ||
12 | |||
13 | =head1 DESCRIPTION | ||
14 | |||
15 | CMS_compress() creates and returns a CMS CompressedData structure. B<comp_nid> | ||
16 | is the compression algorithm to use or B<NID_undef> to use the default | ||
17 | algorithm (zlib compression). B<in> is the content to be compressed. | ||
18 | B<flags> is an optional set of flags. | ||
19 | |||
20 | =head1 NOTES | ||
21 | |||
22 | The only currently supported compression algorithm is zlib using the NID | ||
23 | NID_zlib_compression. | ||
24 | |||
25 | If zlib support is not compiled into OpenSSL then CMS_compress() will return | ||
26 | an error. | ||
27 | |||
28 | If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are | ||
29 | prepended to the data. | ||
30 | |||
31 | Normally the supplied content is translated into MIME canonical format (as | ||
32 | required by the S/MIME specifications) if B<CMS_BINARY> is set no translation | ||
33 | occurs. This option should be used if the supplied data is in binary format | ||
34 | otherwise the translation will corrupt it. If B<CMS_BINARY> is set then | ||
35 | B<CMS_TEXT> is ignored. | ||
36 | |||
37 | If the B<CMS_STREAM> flag is set a partial B<CMS_ContentInfo> structure is | ||
38 | returned suitable for streaming I/O: no data is read from the BIO B<in>. | ||
39 | |||
40 | The compressed data is included in the CMS_ContentInfo structure, unless | ||
41 | B<CMS_DETACHED> is set in which case it is omitted. This is rarely used in | ||
42 | practice and is not supported by SMIME_write_CMS(). | ||
43 | |||
44 | =head1 NOTES | ||
45 | |||
46 | If the flag B<CMS_STREAM> is set the returned B<CMS_ContentInfo> structure is | ||
47 | B<not> complete and outputting its contents via a function that does not | ||
48 | properly finalize the B<CMS_ContentInfo> structure will give unpredictable | ||
49 | results. | ||
50 | |||
51 | Several functions including SMIME_write_CMS(), i2d_CMS_bio_stream(), | ||
52 | PEM_write_bio_CMS_stream() finalize the structure. Alternatively finalization | ||
53 | can be performed by obtaining the streaming ASN1 B<BIO> directly using | ||
54 | BIO_new_CMS(). | ||
55 | |||
56 | Additional compression parameters such as the zlib compression level cannot | ||
57 | currently be set. | ||
58 | |||
59 | =head1 RETURN VALUES | ||
60 | |||
61 | CMS_compress() returns either a CMS_ContentInfo structure or NULL if an error | ||
62 | occurred. The error can be obtained from ERR_get_error(3). | ||
63 | |||
64 | =head1 SEE ALSO | ||
65 | |||
66 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_uncompress(3)|CMS_uncompress(3)> | ||
67 | |||
68 | =head1 HISTORY | ||
69 | |||
70 | CMS_compress() was added to OpenSSL 0.9.8 | ||
71 | The B<CMS_STREAM> flag was first supported in OpenSSL 1.0.0. | ||
72 | |||
73 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_decrypt.pod b/src/lib/libssl/src/doc/crypto/CMS_decrypt.pod deleted file mode 100644 index 3b44cec603..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_decrypt.pod +++ /dev/null | |||
@@ -1,79 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_decrypt - decrypt content from a CMS envelopedData structure | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/cms.h> | ||
10 | |||
11 | int CMS_decrypt(CMS_ContentInfo *cms, EVP_PKEY *pkey, X509 *cert, BIO *dcont, BIO *out, unsigned int flags); | ||
12 | |||
13 | =head1 DESCRIPTION | ||
14 | |||
15 | CMS_decrypt() extracts and decrypts the content from a CMS EnvelopedData | ||
16 | structure. B<pkey> is the private key of the recipient, B<cert> is the | ||
17 | recipient's certificate, B<out> is a BIO to write the content to and | ||
18 | B<flags> is an optional set of flags. | ||
19 | |||
20 | The B<dcont> parameter is used in the rare case where the encrypted content | ||
21 | is detached. It will normally be set to NULL. | ||
22 | |||
23 | =head1 NOTES | ||
24 | |||
25 | OpenSSL_add_all_algorithms() (or equivalent) should be called before using this | ||
26 | function or errors about unknown algorithms will occur. | ||
27 | |||
28 | Although the recipients certificate is not needed to decrypt the data it is | ||
29 | needed to locate the appropriate (of possible several) recipients in the CMS | ||
30 | structure. | ||
31 | |||
32 | If B<cert> is set to NULL all possible recipients are tried. This case however | ||
33 | is problematic. To thwart the MMA attack (Bleichenbacher's attack on | ||
34 | PKCS #1 v1.5 RSA padding) all recipients are tried whether they succeed or | ||
35 | not. If no recipient succeeds then a random symmetric key is used to decrypt | ||
36 | the content: this will typically output garbage and may (but is not guaranteed | ||
37 | to) ultimately return a padding error only. If CMS_decrypt() just returned an | ||
38 | error when all recipient encrypted keys failed to decrypt an attacker could | ||
39 | use this in a timing attack. If the special flag B<CMS_DEBUG_DECRYPT> is set | ||
40 | then the above behaviour is modified and an error B<is> returned if no | ||
41 | recipient encrypted key can be decrypted B<without> generating a random | ||
42 | content encryption key. Applications should use this flag with | ||
43 | B<extreme caution> especially in automated gateways as it can leave them | ||
44 | open to attack. | ||
45 | |||
46 | It is possible to determine the correct recipient key by other means (for | ||
47 | example looking them up in a database) and setting them in the CMS structure | ||
48 | in advance using the CMS utility functions such as CMS_set1_pkey(). In this | ||
49 | case both B<cert> and B<pkey> should be set to NULL. | ||
50 | |||
51 | To process KEKRecipientInfo types CMS_set1_key() or CMS_RecipientInfo_set0_key() | ||
52 | and CMS_ReceipientInfo_decrypt() should be called before CMS_decrypt() and | ||
53 | B<cert> and B<pkey> set to NULL. | ||
54 | |||
55 | The following flags can be passed in the B<flags> parameter. | ||
56 | |||
57 | If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are deleted | ||
58 | from the content. If the content is not of type B<text/plain> then an error is | ||
59 | returned. | ||
60 | |||
61 | =head1 RETURN VALUES | ||
62 | |||
63 | CMS_decrypt() returns either 1 for success or 0 for failure. | ||
64 | The error can be obtained from ERR_get_error(3) | ||
65 | |||
66 | =head1 BUGS | ||
67 | |||
68 | The lack of single pass processing and the need to hold all data in memory as | ||
69 | mentioned in CMS_verify() also applies to CMS_decrypt(). | ||
70 | |||
71 | =head1 SEE ALSO | ||
72 | |||
73 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_encrypt(3)|CMS_encrypt(3)> | ||
74 | |||
75 | =head1 HISTORY | ||
76 | |||
77 | CMS_decrypt() was added to OpenSSL 0.9.8 | ||
78 | |||
79 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_encrypt.pod b/src/lib/libssl/src/doc/crypto/CMS_encrypt.pod deleted file mode 100644 index f697e87e2b..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_encrypt.pod +++ /dev/null | |||
@@ -1,93 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_encrypt - create a CMS envelopedData structure | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/cms.h> | ||
10 | |||
11 | CMS_ContentInfo *CMS_encrypt(STACK_OF(X509) *certs, BIO *in, const EVP_CIPHER *cipher, unsigned int flags); | ||
12 | |||
13 | =head1 DESCRIPTION | ||
14 | |||
15 | CMS_encrypt() creates and returns a CMS EnvelopedData structure. B<certs> | ||
16 | is a list of recipient certificates. B<in> is the content to be encrypted. | ||
17 | B<cipher> is the symmetric cipher to use. B<flags> is an optional set of flags. | ||
18 | |||
19 | =head1 NOTES | ||
20 | |||
21 | Only certificates carrying RSA keys are supported so the recipient certificates | ||
22 | supplied to this function must all contain RSA public keys, though they do not | ||
23 | have to be signed using the RSA algorithm. | ||
24 | |||
25 | The algorithm passed in the B<cipher> parameter must support ASN1 encoding of | ||
26 | its parameters. | ||
27 | |||
28 | Many browsers implement a "sign and encrypt" option which is simply an S/MIME | ||
29 | envelopedData containing an S/MIME signed message. This can be readily produced | ||
30 | by storing the S/MIME signed message in a memory BIO and passing it to | ||
31 | CMS_encrypt(). | ||
32 | |||
33 | The following flags can be passed in the B<flags> parameter. | ||
34 | |||
35 | If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are | ||
36 | prepended to the data. | ||
37 | |||
38 | Normally the supplied content is translated into MIME canonical format (as | ||
39 | required by the S/MIME specifications) if B<CMS_BINARY> is set no translation | ||
40 | occurs. This option should be used if the supplied data is in binary format | ||
41 | otherwise the translation will corrupt it. If B<CMS_BINARY> is set then | ||
42 | B<CMS_TEXT> is ignored. | ||
43 | |||
44 | OpenSSL will by default identify recipient certificates using issuer name | ||
45 | and serial number. If B<CMS_USE_KEYID> is set it will use the subject key | ||
46 | identifier value instead. An error occurs if all recipient certificates do not | ||
47 | have a subject key identifier extension. | ||
48 | |||
49 | If the B<CMS_STREAM> flag is set a partial B<CMS_ContentInfo> structure is | ||
50 | returned suitable for streaming I/O: no data is read from the BIO B<in>. | ||
51 | |||
52 | If the B<CMS_PARTIAL> flag is set a partial B<CMS_ContentInfo> structure is | ||
53 | returned to which additional recipients and attributes can be added before | ||
54 | finalization. | ||
55 | |||
56 | The data being encrypted is included in the CMS_ContentInfo structure, unless | ||
57 | B<CMS_DETACHED> is set in which case it is omitted. This is rarely used in | ||
58 | practice and is not supported by SMIME_write_CMS(). | ||
59 | |||
60 | =head1 NOTES | ||
61 | |||
62 | If the flag B<CMS_STREAM> is set the returned B<CMS_ContentInfo> structure is | ||
63 | B<not> complete and outputting its contents via a function that does not | ||
64 | properly finalize the B<CMS_ContentInfo> structure will give unpredictable | ||
65 | results. | ||
66 | |||
67 | Several functions including SMIME_write_CMS(), i2d_CMS_bio_stream(), | ||
68 | PEM_write_bio_CMS_stream() finalize the structure. Alternatively finalization | ||
69 | can be performed by obtaining the streaming ASN1 B<BIO> directly using | ||
70 | BIO_new_CMS(). | ||
71 | |||
72 | The recipients specified in B<certs> use a CMS KeyTransRecipientInfo info | ||
73 | structure. KEKRecipientInfo is also supported using the flag B<CMS_PARTIAL> | ||
74 | and CMS_add0_recipient_key(). | ||
75 | |||
76 | The parameter B<certs> may be NULL if B<CMS_PARTIAL> is set and recipients | ||
77 | added later using CMS_add1_recipient_cert() or CMS_add0_recipient_key(). | ||
78 | |||
79 | =head1 RETURN VALUES | ||
80 | |||
81 | CMS_encrypt() returns either a CMS_ContentInfo structure or NULL if an error | ||
82 | occurred. The error can be obtained from ERR_get_error(3). | ||
83 | |||
84 | =head1 SEE ALSO | ||
85 | |||
86 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_decrypt(3)|CMS_decrypt(3)> | ||
87 | |||
88 | =head1 HISTORY | ||
89 | |||
90 | CMS_decrypt() was added to OpenSSL 0.9.8 | ||
91 | The B<CMS_STREAM> flag was first supported in OpenSSL 1.0.0. | ||
92 | |||
93 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_final.pod b/src/lib/libssl/src/doc/crypto/CMS_final.pod deleted file mode 100644 index c5f1722aaf..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_final.pod +++ /dev/null | |||
@@ -1,41 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_final - finalise a CMS_ContentInfo structure | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/cms.h> | ||
10 | |||
11 | int CMS_final(CMS_ContentInfo *cms, BIO *data, BIO *dcont, unsigned int flags); | ||
12 | |||
13 | =head1 DESCRIPTION | ||
14 | |||
15 | CMS_final() finalises the structure B<cms>. It's purpose is to perform any | ||
16 | operations necessary on B<cms> (digest computation for example) and set the | ||
17 | appropriate fields. The parameter B<data> contains the content to be | ||
18 | processed. The B<dcont> parameter contains a BIO to write content to after | ||
19 | processing: this is only used with detached data and will usually be set to | ||
20 | NULL. | ||
21 | |||
22 | =head1 NOTES | ||
23 | |||
24 | This function will normally be called when the B<CMS_PARTIAL> flag is used. It | ||
25 | should only be used when streaming is not performed because the streaming | ||
26 | I/O functions perform finalisation operations internally. | ||
27 | |||
28 | =head1 RETURN VALUES | ||
29 | |||
30 | CMS_final() returns 1 for success or 0 for failure. | ||
31 | |||
32 | =head1 SEE ALSO | ||
33 | |||
34 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_sign(3)|CMS_sign(3)>, | ||
35 | L<CMS_encrypt(3)|CMS_encrypt(3)> | ||
36 | |||
37 | =head1 HISTORY | ||
38 | |||
39 | CMS_final() was added to OpenSSL 0.9.8 | ||
40 | |||
41 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_get0_RecipientInfos.pod b/src/lib/libssl/src/doc/crypto/CMS_get0_RecipientInfos.pod deleted file mode 100644 index da3914c0c0..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_get0_RecipientInfos.pod +++ /dev/null | |||
@@ -1,111 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_get0_RecipientInfos, CMS_RecipientInfo_type, | ||
6 | CMS_RecipientInfo_ktri_get0_signer_id,CMS_RecipientInfo_ktri_cert_cmp, | ||
7 | CMS_RecipientInfo_set0_pkey, CMS_RecipientInfo_kekri_get0_id, | ||
8 | CMS_RecipientInfo_kekri_id_cmp, CMS_RecipientInfo_set0_key, | ||
9 | CMS_RecipientInfo_decrypt, | ||
10 | CMS_RecipientInfo_encrypt - CMS envelopedData RecipientInfo routines | ||
11 | |||
12 | =head1 SYNOPSIS | ||
13 | |||
14 | #include <openssl/cms.h> | ||
15 | |||
16 | STACK_OF(CMS_RecipientInfo) *CMS_get0_RecipientInfos(CMS_ContentInfo *cms); | ||
17 | int CMS_RecipientInfo_type(CMS_RecipientInfo *ri); | ||
18 | |||
19 | int CMS_RecipientInfo_ktri_get0_signer_id(CMS_RecipientInfo *ri, ASN1_OCTET_STRING **keyid, X509_NAME **issuer, ASN1_INTEGER **sno); | ||
20 | int CMS_RecipientInfo_ktri_cert_cmp(CMS_RecipientInfo *ri, X509 *cert); | ||
21 | int CMS_RecipientInfo_set0_pkey(CMS_RecipientInfo *ri, EVP_PKEY *pkey); | ||
22 | |||
23 | int CMS_RecipientInfo_kekri_get0_id(CMS_RecipientInfo *ri, X509_ALGOR **palg, ASN1_OCTET_STRING **pid, ASN1_GENERALIZEDTIME **pdate, ASN1_OBJECT **potherid, ASN1_TYPE **pothertype); | ||
24 | int CMS_RecipientInfo_kekri_id_cmp(CMS_RecipientInfo *ri, const unsigned char *id, size_t idlen); | ||
25 | int CMS_RecipientInfo_set0_key(CMS_RecipientInfo *ri, unsigned char *key, size_t keylen); | ||
26 | |||
27 | int CMS_RecipientInfo_decrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri); | ||
28 | |||
29 | =head1 DESCRIPTION | ||
30 | |||
31 | The function CMS_get0_RecipientInfos() returns all the CMS_RecipientInfo | ||
32 | structures associated with a CMS EnvelopedData structure. | ||
33 | |||
34 | CMS_RecipientInfo_type() returns the type of CMS_RecipientInfo structure B<ri>. | ||
35 | It will currently return CMS_RECIPINFO_TRANS, CMS_RECIPINFO_AGREE, | ||
36 | CMS_RECIPINFO_KEK, CMS_RECIPINFO_PASS, or CMS_RECIPINFO_OTHER. | ||
37 | |||
38 | CMS_RecipientInfo_ktri_get0_signer_id() retrieves the certificate recipient | ||
39 | identifier associated with a specific CMS_RecipientInfo structure B<ri>, which | ||
40 | must be of type CMS_RECIPINFO_TRANS. Either the keyidentifier will be set in | ||
41 | B<keyid> or B<both> issuer name and serial number in B<issuer> and B<sno>. | ||
42 | |||
43 | CMS_RecipientInfo_ktri_cert_cmp() compares the certificate B<cert> against the | ||
44 | CMS_RecipientInfo structure B<ri>, which must be of type CMS_RECIPINFO_TRANS. | ||
45 | It returns zero if the comparison is successful and non zero if not. | ||
46 | |||
47 | CMS_RecipientInfo_set0_pkey() associates the private key B<pkey> with | ||
48 | the CMS_RecipientInfo structure B<ri>, which must be of type | ||
49 | CMS_RECIPINFO_TRANS. | ||
50 | |||
51 | CMS_RecipientInfo_kekri_get0_id() retrieves the key information from the | ||
52 | CMS_RecipientInfo structure B<ri> which must be of type CMS_RECIPINFO_KEK. Any | ||
53 | of the remaining parameters can be NULL if the application is not interested in | ||
54 | the value of a field. Where a field is optional and absent NULL will be written | ||
55 | to the corresponding parameter. The keyEncryptionAlgorithm field is written to | ||
56 | B<palg>, the B<keyIdentifier> field is written to B<pid>, the B<date> field if | ||
57 | present is written to B<pdate>, if the B<other> field is present the components | ||
58 | B<keyAttrId> and B<keyAttr> are written to parameters B<potherid> and | ||
59 | B<pothertype>. | ||
60 | |||
61 | CMS_RecipientInfo_kekri_id_cmp() compares the ID in the B<id> and B<idlen> | ||
62 | parameters against the B<keyIdentifier> CMS_RecipientInfo structure B<ri>, | ||
63 | which must be of type CMS_RECIPINFO_KEK. It returns zero if the comparison is | ||
64 | successful and non zero if not. | ||
65 | |||
66 | CMS_RecipientInfo_set0_key() associates the symmetric key B<key> of length | ||
67 | B<keylen> with the CMS_RecipientInfo structure B<ri>, which must be of type | ||
68 | CMS_RECIPINFO_KEK. | ||
69 | |||
70 | CMS_RecipientInfo_decrypt() attempts to decrypt CMS_RecipientInfo structure | ||
71 | B<ri> in structure B<cms>. A key must have been associated with the structure | ||
72 | first. | ||
73 | |||
74 | =head1 NOTES | ||
75 | |||
76 | The main purpose of these functions is to enable an application to lookup | ||
77 | recipient keys using any appropriate technique when the simpler method | ||
78 | of CMS_decrypt() is not appropriate. | ||
79 | |||
80 | In typical usage and application will retrieve all CMS_RecipientInfo structures | ||
81 | using CMS_get0_RecipientInfos() and check the type of each using | ||
82 | CMS_RecpientInfo_type(). Depending on the type the CMS_RecipientInfo structure | ||
83 | can be ignored or its key identifier data retrieved using an appropriate | ||
84 | function. Then if the corresponding secret or private key can be obtained by | ||
85 | any appropriate means it can then associated with the structure and | ||
86 | CMS_RecpientInfo_decrypt() called. If successful CMS_decrypt() can be called | ||
87 | with a NULL key to decrypt the enveloped content. | ||
88 | |||
89 | =head1 RETURN VALUES | ||
90 | |||
91 | CMS_get0_RecipientInfos() returns all CMS_RecipientInfo structures, or NULL if | ||
92 | an error occurs. | ||
93 | |||
94 | CMS_RecipientInfo_ktri_get0_signer_id(), CMS_RecipientInfo_set0_pkey(), | ||
95 | CMS_RecipientInfo_kekri_get0_id(), CMS_RecipientInfo_set0_key() and | ||
96 | CMS_RecipientInfo_decrypt() return 1 for success or 0 if an error occurs. | ||
97 | |||
98 | CMS_RecipientInfo_ktri_cert_cmp() and CMS_RecipientInfo_kekri_cmp() return 0 | ||
99 | for a successful comparison and non zero otherwise. | ||
100 | |||
101 | Any error can be obtained from L<ERR_get_error(3)|ERR_get_error(3)>. | ||
102 | |||
103 | =head1 SEE ALSO | ||
104 | |||
105 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_decrypt(3)|CMS_decrypt(3)> | ||
106 | |||
107 | =head1 HISTORY | ||
108 | |||
109 | These functions were first was added to OpenSSL 0.9.8 | ||
110 | |||
111 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_get0_SignerInfos.pod b/src/lib/libssl/src/doc/crypto/CMS_get0_SignerInfos.pod deleted file mode 100644 index 557cda6c3e..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_get0_SignerInfos.pod +++ /dev/null | |||
@@ -1,76 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_get0_SignerInfos, CMS_SignerInfo_get0_signer_id, CMS_SignerInfo_cert_cmp, | ||
6 | CMS_set1_signer_certs - CMS signedData signer functions. | ||
7 | |||
8 | =head1 SYNOPSIS | ||
9 | |||
10 | #include <openssl/cms.h> | ||
11 | |||
12 | STACK_OF(CMS_SignerInfo) *CMS_get0_SignerInfos(CMS_ContentInfo *cms); | ||
13 | |||
14 | int CMS_SignerInfo_get0_signer_id(CMS_SignerInfo *si, ASN1_OCTET_STRING **keyid, X509_NAME **issuer, ASN1_INTEGER **sno); | ||
15 | int CMS_SignerInfo_cert_cmp(CMS_SignerInfo *si, X509 *cert); | ||
16 | void CMS_SignerInfo_set1_signer_cert(CMS_SignerInfo *si, X509 *signer); | ||
17 | |||
18 | =head1 DESCRIPTION | ||
19 | |||
20 | The function CMS_get0_SignerInfos() returns all the CMS_SignerInfo structures | ||
21 | associated with a CMS signedData structure. | ||
22 | |||
23 | CMS_SignerInfo_get0_signer_id() retrieves the certificate signer identifier | ||
24 | associated with a specific CMS_SignerInfo structure B<si>. Either the | ||
25 | keyidentifier will be set in B<keyid> or B<both> issuer name and serial number | ||
26 | in B<issuer> and B<sno>. | ||
27 | |||
28 | CMS_SignerInfo_cert_cmp() compares the certificate B<cert> against the signer | ||
29 | identifier B<si>. It returns zero if the comparison is successful and non zero | ||
30 | if not. | ||
31 | |||
32 | CMS_SignerInfo_set1_signer_cert() sets the signers certificate of B<si> to | ||
33 | B<signer>. | ||
34 | |||
35 | =head1 NOTES | ||
36 | |||
37 | The main purpose of these functions is to enable an application to lookup | ||
38 | signers certificates using any appropriate technique when the simpler method | ||
39 | of CMS_verify() is not appropriate. | ||
40 | |||
41 | In typical usage and application will retrieve all CMS_SignerInfo structures | ||
42 | using CMS_get0_SignerInfo() and retrieve the identifier information using | ||
43 | CMS. It will then obtain the signer certificate by some unspecified means | ||
44 | (or return and error if it cannot be found) and set it using | ||
45 | CMS_SignerInfo_set1_signer_cert(). | ||
46 | |||
47 | Once all signer certificates have been set CMS_verify() can be used. | ||
48 | |||
49 | Although CMS_get0_SignerInfos() can return NULL is an error occur B<or> if | ||
50 | there are no signers this is not a problem in practice because the only | ||
51 | error which can occur is if the B<cms> structure is not of type signedData | ||
52 | due to application error. | ||
53 | |||
54 | =head1 RETURN VALUES | ||
55 | |||
56 | CMS_get0_SignerInfos() returns all CMS_SignerInfo structures, or NULL there | ||
57 | are no signers or an error occurs. | ||
58 | |||
59 | CMS_SignerInfo_get0_signer_id() returns 1 for success and 0 for failure. | ||
60 | |||
61 | CMS_SignerInfo_cert_cmp() returns 0 for a successful comparison and non | ||
62 | zero otherwise. | ||
63 | |||
64 | CMS_SignerInfo_set1_signer_cert() does not return a value. | ||
65 | |||
66 | Any error can be obtained from L<ERR_get_error(3)|ERR_get_error(3)> | ||
67 | |||
68 | =head1 SEE ALSO | ||
69 | |||
70 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_verify(3)|CMS_verify(3)> | ||
71 | |||
72 | =head1 HISTORY | ||
73 | |||
74 | These functions were first was added to OpenSSL 0.9.8 | ||
75 | |||
76 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_get0_type.pod b/src/lib/libssl/src/doc/crypto/CMS_get0_type.pod deleted file mode 100644 index bc2690ee1a..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_get0_type.pod +++ /dev/null | |||
@@ -1,64 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_get0_type, CMS_set1_eContentType, CMS_get0_eContentType - get and set CMS | ||
6 | content types | ||
7 | |||
8 | =head1 SYNOPSIS | ||
9 | |||
10 | #include <openssl/cms.h> | ||
11 | |||
12 | const ASN1_OBJECT *CMS_get0_type(CMS_ContentInfo *cms); | ||
13 | int CMS_set1_eContentType(CMS_ContentInfo *cms, const ASN1_OBJECT *oid); | ||
14 | const ASN1_OBJECT *CMS_get0_eContentType(CMS_ContentInfo *cms); | ||
15 | |||
16 | =head1 DESCRIPTION | ||
17 | |||
18 | CMS_get0_type() returns the content type of a CMS_ContentInfo structure as | ||
19 | and ASN1_OBJECT pointer. An application can then decide how to process the | ||
20 | CMS_ContentInfo structure based on this value. | ||
21 | |||
22 | CMS_set1_eContentType() sets the embedded content type of a CMS_ContentInfo | ||
23 | structure. It should be called with CMS functions with the B<CMS_PARTIAL> | ||
24 | flag and B<before> the structure is finalised, otherwise the results are | ||
25 | undefined. | ||
26 | |||
27 | ASN1_OBJECT *CMS_get0_eContentType() returns a pointer to the embedded | ||
28 | content type. | ||
29 | |||
30 | =head1 NOTES | ||
31 | |||
32 | As the B<0> implies CMS_get0_type() and CMS_get0_eContentType() return internal | ||
33 | pointers which should B<not> be freed up. CMS_set1_eContentType() copies the | ||
34 | supplied OID and it B<should> be freed up after use. | ||
35 | |||
36 | The B<ASN1_OBJECT> values returned can be converted to an integer B<NID> value | ||
37 | using OBJ_obj2nid(). For the currently supported content types the following | ||
38 | values are returned: | ||
39 | |||
40 | NID_pkcs7_data | ||
41 | NID_pkcs7_signed | ||
42 | NID_pkcs7_digest | ||
43 | NID_id_smime_ct_compressedData: | ||
44 | NID_pkcs7_encrypted | ||
45 | NID_pkcs7_enveloped | ||
46 | |||
47 | |||
48 | =head1 RETURN VALUES | ||
49 | |||
50 | CMS_get0_type() and CMS_get0_eContentType() return and ASN1_OBJECT structure. | ||
51 | |||
52 | CMS_set1_eContentType() returns 1 for success or 0 if an error occurred. The | ||
53 | error can be obtained from ERR_get_error(3). | ||
54 | |||
55 | =head1 SEE ALSO | ||
56 | |||
57 | L<ERR_get_error(3)|ERR_get_error(3)> | ||
58 | |||
59 | =head1 HISTORY | ||
60 | |||
61 | CMS_get0_type(), CMS_set1_eContentType() and CMS_get0_eContentType() were all | ||
62 | first added to OpenSSL 0.9.8 | ||
63 | |||
64 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_get1_ReceiptRequest.pod b/src/lib/libssl/src/doc/crypto/CMS_get1_ReceiptRequest.pod deleted file mode 100644 index a7babb1a6e..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_get1_ReceiptRequest.pod +++ /dev/null | |||
@@ -1,70 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_ReceiptRequest_create0, CMS_add1_ReceiptRequest, CMS_get1_ReceiptRequest, | ||
6 | CMS_ReceiptRequest_get0_values - CMS signed receipt request functions. | ||
7 | |||
8 | =head1 SYNOPSIS | ||
9 | |||
10 | #include <openssl/cms.h> | ||
11 | |||
12 | CMS_ReceiptRequest *CMS_ReceiptRequest_create0(unsigned char *id, int idlen, int allorfirst, STACK_OF(GENERAL_NAMES) *receiptList, STACK_OF(GENERAL_NAMES) *receiptsTo); | ||
13 | int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr); | ||
14 | int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr); | ||
15 | void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr, ASN1_STRING **pcid, int *pallorfirst, STACK_OF(GENERAL_NAMES) **plist, STACK_OF(GENERAL_NAMES) **prto); | ||
16 | |||
17 | =head1 DESCRIPTION | ||
18 | |||
19 | CMS_ReceiptRequest_create0() creates a signed receipt request structure. The | ||
20 | B<signedContentIdentifier> field is set using B<id> and B<idlen>, or it is set | ||
21 | to 32 bytes of pseudo random data if B<id> is NULL. If B<receiptList> is NULL | ||
22 | the allOrFirstTier option in B<receiptsFrom> is used and set to the value of | ||
23 | the B<allorfirst> parameter. If B<receiptList> is not NULL the B<receiptList> | ||
24 | option in B<receiptsFrom> is used. The B<receiptsTo> parameter specifies the | ||
25 | B<receiptsTo> field value. | ||
26 | |||
27 | The CMS_add1_ReceiptRequest() function adds a signed receipt request B<rr> | ||
28 | to SignerInfo structure B<si>. | ||
29 | |||
30 | int CMS_get1_ReceiptRequest() looks for a signed receipt request in B<si>, if | ||
31 | any is found it is decoded and written to B<prr>. | ||
32 | |||
33 | CMS_ReceiptRequest_get0_values() retrieves the values of a receipt request. | ||
34 | The signedContentIdentifier is copied to B<pcid>. If the B<allOrFirstTier> | ||
35 | option of B<receiptsFrom> is used its value is copied to B<pallorfirst> | ||
36 | otherwise the B<receiptList> field is copied to B<plist>. The B<receiptsTo> | ||
37 | parameter is copied to B<prto>. | ||
38 | |||
39 | =head1 NOTES | ||
40 | |||
41 | For more details of the meaning of the fields see RFC2634. | ||
42 | |||
43 | The contents of a signed receipt should only be considered meaningful if the | ||
44 | corresponding CMS_ContentInfo structure can be successfully verified using | ||
45 | CMS_verify(). | ||
46 | |||
47 | =head1 RETURN VALUES | ||
48 | |||
49 | CMS_ReceiptRequest_create0() returns a signed receipt request structure or | ||
50 | NULL if an error occurred. | ||
51 | |||
52 | CMS_add1_ReceiptRequest() returns 1 for success or 0 is an error occurred. | ||
53 | |||
54 | CMS_get1_ReceiptRequest() returns 1 is a signed receipt request is found and | ||
55 | decoded. It returns 0 if a signed receipt request is not present and -1 if | ||
56 | it is present but malformed. | ||
57 | |||
58 | =head1 SEE ALSO | ||
59 | |||
60 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_sign(3)|CMS_sign(3)>, | ||
61 | L<CMS_sign_receipt(3)|CMS_sign_receipt(3)>, L<CMS_verify(3)|CMS_verify(3)> | ||
62 | L<CMS_verify_receipt(3)|CMS_verify_receipt(3)> | ||
63 | |||
64 | =head1 HISTORY | ||
65 | |||
66 | CMS_ReceiptRequest_create0(), CMS_add1_ReceiptRequest(), | ||
67 | CMS_get1_ReceiptRequest() and CMS_ReceiptRequest_get0_values() were added to | ||
68 | OpenSSL 0.9.8 | ||
69 | |||
70 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_sign.pod b/src/lib/libssl/src/doc/crypto/CMS_sign.pod deleted file mode 100644 index cc6d17faf6..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_sign.pod +++ /dev/null | |||
@@ -1,122 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_sign - create a CMS SignedData structure | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/cms.h> | ||
10 | |||
11 | CMS_ContentInfo *CMS_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, BIO *data, unsigned int flags); | ||
12 | |||
13 | =head1 DESCRIPTION | ||
14 | |||
15 | CMS_sign() creates and returns a CMS SignedData structure. B<signcert> is | ||
16 | the certificate to sign with, B<pkey> is the corresponding private key. | ||
17 | B<certs> is an optional additional set of certificates to include in the CMS | ||
18 | structure (for example any intermediate CAs in the chain). Any or all of | ||
19 | these parameters can be B<NULL>, see B<NOTES> below. | ||
20 | |||
21 | The data to be signed is read from BIO B<data>. | ||
22 | |||
23 | B<flags> is an optional set of flags. | ||
24 | |||
25 | =head1 NOTES | ||
26 | |||
27 | Any of the following flags (ored together) can be passed in the B<flags> | ||
28 | parameter. | ||
29 | |||
30 | Many S/MIME clients expect the signed content to include valid MIME headers. If | ||
31 | the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are prepended | ||
32 | to the data. | ||
33 | |||
34 | If B<CMS_NOCERTS> is set the signer's certificate will not be included in the | ||
35 | CMS_ContentInfo structure, the signer's certificate must still be supplied in | ||
36 | the B<signcert> parameter though. This can reduce the size of the signature if | ||
37 | the signers certificate can be obtained by other means: for example a | ||
38 | previously signed message. | ||
39 | |||
40 | The data being signed is included in the CMS_ContentInfo structure, unless | ||
41 | B<CMS_DETACHED> is set in which case it is omitted. This is used for | ||
42 | CMS_ContentInfo detached signatures which are used in S/MIME plaintext signed | ||
43 | messages for example. | ||
44 | |||
45 | Normally the supplied content is translated into MIME canonical format (as | ||
46 | required by the S/MIME specifications) if B<CMS_BINARY> is set no translation | ||
47 | occurs. This option should be used if the supplied data is in binary format | ||
48 | otherwise the translation will corrupt it. | ||
49 | |||
50 | The SignedData structure includes several CMS signedAttributes including the | ||
51 | signing time, the CMS content type and the supported list of ciphers in an | ||
52 | SMIMECapabilities attribute. If B<CMS_NOATTR> is set then no signedAttributes | ||
53 | will be used. If B<CMS_NOSMIMECAP> is set then just the SMIMECapabilities are | ||
54 | omitted. | ||
55 | |||
56 | If present the SMIMECapabilities attribute indicates support for the following | ||
57 | algorithms in preference order: 256 bit AES, Gost R3411-94, Gost 28147-89, 192 | ||
58 | bit AES, 128 bit AES, triple DES, 128 bit RC2, 64 bit RC2, DES and 40 bit RC2. | ||
59 | If any of these algorithms is not available then it will not be included: for | ||
60 | example the GOST algorithms will not be included if the GOST ENGINE is not | ||
61 | loaded. | ||
62 | |||
63 | OpenSSL will by default identify signing certificates using issuer name | ||
64 | and serial number. If B<CMS_USE_KEYID> is set it will use the subject key | ||
65 | identifier value instead. An error occurs if the signing certificate does not | ||
66 | have a subject key identifier extension. | ||
67 | |||
68 | If the flags B<CMS_STREAM> is set then the returned B<CMS_ContentInfo> | ||
69 | structure is just initialized ready to perform the signing operation. The | ||
70 | signing is however B<not> performed and the data to be signed is not read from | ||
71 | the B<data> parameter. Signing is deferred until after the data has been | ||
72 | written. In this way data can be signed in a single pass. | ||
73 | |||
74 | If the B<CMS_PARTIAL> flag is set a partial B<CMS_ContentInfo> structure is | ||
75 | output to which additional signers and capabilities can be added before | ||
76 | finalization. | ||
77 | |||
78 | If the flag B<CMS_STREAM> is set the returned B<CMS_ContentInfo> structure is | ||
79 | B<not> complete and outputting its contents via a function that does not | ||
80 | properly finalize the B<CMS_ContentInfo> structure will give unpredictable | ||
81 | results. | ||
82 | |||
83 | Several functions including SMIME_write_CMS(), i2d_CMS_bio_stream(), | ||
84 | PEM_write_bio_CMS_stream() finalize the structure. Alternatively finalization | ||
85 | can be performed by obtaining the streaming ASN1 B<BIO> directly using | ||
86 | BIO_new_CMS(). | ||
87 | |||
88 | If a signer is specified it will use the default digest for the signing | ||
89 | algorithm. This is B<SHA1> for both RSA and DSA keys. | ||
90 | |||
91 | If B<signcert> and B<pkey> are NULL then a certificates only CMS structure is | ||
92 | output. | ||
93 | |||
94 | The function CMS_sign() is a basic CMS signing function whose output will be | ||
95 | suitable for many purposes. For finer control of the output format the | ||
96 | B<certs>, B<signcert> and B<pkey> parameters can all be B<NULL> and the | ||
97 | B<CMS_PARTIAL> flag set. Then one or more signers can be added using the | ||
98 | function CMS_sign_add1_signer(), non default digests can be used and custom | ||
99 | attributes added. B<CMS_final()> must then be called to finalize the | ||
100 | structure if streaming is not enabled. | ||
101 | |||
102 | =head1 BUGS | ||
103 | |||
104 | Some attributes such as counter signatures are not supported. | ||
105 | |||
106 | =head1 RETURN VALUES | ||
107 | |||
108 | CMS_sign() returns either a valid CMS_ContentInfo structure or NULL if an error | ||
109 | occurred. The error can be obtained from ERR_get_error(3). | ||
110 | |||
111 | =head1 SEE ALSO | ||
112 | |||
113 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_verify(3)|CMS_verify(3)> | ||
114 | |||
115 | =head1 HISTORY | ||
116 | |||
117 | CMS_sign() was added to OpenSSL 0.9.8 | ||
118 | |||
119 | The B<CMS_STREAM> flag is only supported for detached data in OpenSSL 0.9.8, | ||
120 | it is supported for embedded data in OpenSSL 1.0.0 and later. | ||
121 | |||
122 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_sign_add1_signer.pod b/src/lib/libssl/src/doc/crypto/CMS_sign_add1_signer.pod deleted file mode 100644 index ed4d9a9234..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_sign_add1_signer.pod +++ /dev/null | |||
@@ -1,103 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_sign_add1_signer, CMS_SignerInfo_sign - add a signer to a CMS_ContentInfo | ||
6 | signed data structure. | ||
7 | |||
8 | =head1 SYNOPSIS | ||
9 | |||
10 | #include <openssl/cms.h> | ||
11 | |||
12 | CMS_SignerInfo *CMS_sign_add1_signer(CMS_ContentInfo *cms, X509 *signcert, EVP_PKEY *pkey, const EVP_MD *md, unsigned int flags); | ||
13 | |||
14 | int CMS_SignerInfo_sign(CMS_SignerInfo *si); | ||
15 | |||
16 | |||
17 | =head1 DESCRIPTION | ||
18 | |||
19 | CMS_sign_add1_signer() adds a signer with certificate B<signcert> and private | ||
20 | key B<pkey> using message digest B<md> to CMS_ContentInfo SignedData | ||
21 | structure B<cms>. | ||
22 | |||
23 | The CMS_ContentInfo structure should be obtained from an initial call to | ||
24 | CMS_sign() with the flag B<CMS_PARTIAL> set or in the case or re-signing a | ||
25 | valid CMS_ContentInfo SignedData structure. | ||
26 | |||
27 | If the B<md> parameter is B<NULL> then the default digest for the public | ||
28 | key algorithm will be used. | ||
29 | |||
30 | Unless the B<CMS_REUSE_DIGEST> flag is set the returned CMS_ContentInfo | ||
31 | structure is not complete and must be finalized either by streaming (if | ||
32 | applicable) or a call to CMS_final(). | ||
33 | |||
34 | The CMS_SignerInfo_sign() function will explicitly sign a CMS_SignerInfo | ||
35 | structure, its main use is when B<CMS_REUSE_DIGEST> and B<CMS_PARTIAL> flags | ||
36 | are both set. | ||
37 | |||
38 | =head1 NOTES | ||
39 | |||
40 | The main purpose of CMS_sign_add1_signer() is to provide finer control | ||
41 | over a CMS signed data structure where the simpler CMS_sign() function defaults | ||
42 | are not appropriate. For example if multiple signers or non default digest | ||
43 | algorithms are needed. New attributes can also be added using the returned | ||
44 | CMS_SignerInfo structure and the CMS attribute utility functions or the | ||
45 | CMS signed receipt request functions. | ||
46 | |||
47 | Any of the following flags (ored together) can be passed in the B<flags> | ||
48 | parameter. | ||
49 | |||
50 | If B<CMS_REUSE_DIGEST> is set then an attempt is made to copy the content | ||
51 | digest value from the CMS_ContentInfo structure: to add a signer to an existing | ||
52 | structure. An error occurs if a matching digest value cannot be found to copy. | ||
53 | The returned CMS_ContentInfo structure will be valid and finalized when this | ||
54 | flag is set. | ||
55 | |||
56 | If B<CMS_PARTIAL> is set in addition to B<CMS_REUSE_DIGEST> then the | ||
57 | CMS_SignerInfo structure will not be finalized so additional attributes | ||
58 | can be added. In this case an explicit call to CMS_SignerInfo_sign() is | ||
59 | needed to finalize it. | ||
60 | |||
61 | If B<CMS_NOCERTS> is set the signer's certificate will not be included in the | ||
62 | CMS_ContentInfo structure, the signer's certificate must still be supplied in | ||
63 | the B<signcert> parameter though. This can reduce the size of the signature if | ||
64 | the signers certificate can be obtained by other means: for example a | ||
65 | previously signed message. | ||
66 | |||
67 | The SignedData structure includes several CMS signedAttributes including the | ||
68 | signing time, the CMS content type and the supported list of ciphers in an | ||
69 | SMIMECapabilities attribute. If B<CMS_NOATTR> is set then no signedAttributes | ||
70 | will be used. If B<CMS_NOSMIMECAP> is set then just the SMIMECapabilities are | ||
71 | omitted. | ||
72 | |||
73 | OpenSSL will by default identify signing certificates using issuer name | ||
74 | and serial number. If B<CMS_USE_KEYID> is set it will use the subject key | ||
75 | identifier value instead. An error occurs if the signing certificate does not | ||
76 | have a subject key identifier extension. | ||
77 | |||
78 | If present the SMIMECapabilities attribute indicates support for the following | ||
79 | algorithms in preference order: 256 bit AES, Gost R3411-94, Gost 28147-89, 192 | ||
80 | bit AES, 128 bit AES, triple DES, 128 bit RC2, 64 bit RC2, DES and 40 bit RC2. | ||
81 | If any of these algorithms is not available then it will not be included: for | ||
82 | example the GOST algorithms will not be included if the GOST ENGINE is not | ||
83 | loaded. | ||
84 | |||
85 | CMS_sign_add1_signer() returns an internal pointer to the CMS_SignerInfo | ||
86 | structure just added, this can be used to set additional attributes | ||
87 | before it is finalized. | ||
88 | |||
89 | =head1 RETURN VALUES | ||
90 | |||
91 | CMS_sign1_add_signers() returns an internal pointer to the CMS_SignerInfo | ||
92 | structure just added or NULL if an error occurs. | ||
93 | |||
94 | =head1 SEE ALSO | ||
95 | |||
96 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_sign(3)|CMS_sign(3)>, | ||
97 | L<CMS_final(3)|CMS_final(3)>, | ||
98 | |||
99 | =head1 HISTORY | ||
100 | |||
101 | CMS_sign_add1_signer() was added to OpenSSL 0.9.8 | ||
102 | |||
103 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_sign_receipt.pod b/src/lib/libssl/src/doc/crypto/CMS_sign_receipt.pod deleted file mode 100644 index f603ab66f0..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_sign_receipt.pod +++ /dev/null | |||
@@ -1,45 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_sign_receipt - create a CMS signed receipt | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/cms.h> | ||
10 | |||
11 | CMS_ContentInfo *CMS_sign_receipt(CMS_SignerInfo *si, X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, unsigned int flags); | ||
12 | |||
13 | =head1 DESCRIPTION | ||
14 | |||
15 | CMS_sign_receipt() creates and returns a CMS signed receipt structure. B<si> is | ||
16 | the B<CMS_SignerInfo> structure containing the signed receipt request. | ||
17 | B<signcert> is the certificate to sign with, B<pkey> is the corresponding | ||
18 | private key. B<certs> is an optional additional set of certificates to include | ||
19 | in the CMS structure (for example any intermediate CAs in the chain). | ||
20 | |||
21 | B<flags> is an optional set of flags. | ||
22 | |||
23 | =head1 NOTES | ||
24 | |||
25 | This functions behaves in a similar way to CMS_sign() except the flag values | ||
26 | B<CMS_DETACHED>, B<CMS_BINARY>, B<CMS_NOATTR>, B<CMS_TEXT> and B<CMS_STREAM> | ||
27 | are not supported since they do not make sense in the context of signed | ||
28 | receipts. | ||
29 | |||
30 | =head1 RETURN VALUES | ||
31 | |||
32 | CMS_sign_receipt() returns either a valid CMS_ContentInfo structure or NULL if | ||
33 | an error occurred. The error can be obtained from ERR_get_error(3). | ||
34 | |||
35 | =head1 SEE ALSO | ||
36 | |||
37 | L<ERR_get_error(3)|ERR_get_error(3)>, | ||
38 | L<CMS_verify_receipt(3)|CMS_verify_receipt(3)>, | ||
39 | L<CMS_sign(3)|CMS_sign(3)> | ||
40 | |||
41 | =head1 HISTORY | ||
42 | |||
43 | CMS_sign_receipt() was added to OpenSSL 0.9.8 | ||
44 | |||
45 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_uncompress.pod b/src/lib/libssl/src/doc/crypto/CMS_uncompress.pod deleted file mode 100644 index fcbfec128a..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_uncompress.pod +++ /dev/null | |||
@@ -1,54 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_uncompress - uncompress a CMS CompressedData structure | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/cms.h> | ||
10 | |||
11 | int CMS_uncompress(CMS_ContentInfo *cms, BIO *dcont, BIO *out, unsigned int flags); | ||
12 | |||
13 | =head1 DESCRIPTION | ||
14 | |||
15 | CMS_uncompress() extracts and uncompresses the content from a CMS | ||
16 | CompressedData structure B<cms>. B<data> is a BIO to write the content to and | ||
17 | B<flags> is an optional set of flags. | ||
18 | |||
19 | The B<dcont> parameter is used in the rare case where the compressed content | ||
20 | is detached. It will normally be set to NULL. | ||
21 | |||
22 | =head1 NOTES | ||
23 | |||
24 | The only currently supported compression algorithm is zlib: if the structure | ||
25 | indicates the use of any other algorithm an error is returned. | ||
26 | |||
27 | If zlib support is not compiled into OpenSSL then CMS_uncompress() will always | ||
28 | return an error. | ||
29 | |||
30 | The following flags can be passed in the B<flags> parameter. | ||
31 | |||
32 | If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are deleted | ||
33 | from the content. If the content is not of type B<text/plain> then an error is | ||
34 | returned. | ||
35 | |||
36 | =head1 RETURN VALUES | ||
37 | |||
38 | CMS_uncompress() returns either 1 for success or 0 for failure. The error can | ||
39 | be obtained from ERR_get_error(3) | ||
40 | |||
41 | =head1 BUGS | ||
42 | |||
43 | The lack of single pass processing and the need to hold all data in memory as | ||
44 | mentioned in CMS_verify() also applies to CMS_decompress(). | ||
45 | |||
46 | =head1 SEE ALSO | ||
47 | |||
48 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_compress(3)|CMS_compress(3)> | ||
49 | |||
50 | =head1 HISTORY | ||
51 | |||
52 | CMS_uncompress() was added to OpenSSL 0.9.8 | ||
53 | |||
54 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_verify.pod b/src/lib/libssl/src/doc/crypto/CMS_verify.pod deleted file mode 100644 index 69425008aa..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_verify.pod +++ /dev/null | |||
@@ -1,126 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_verify, CMS_get0_signers - verify a CMS SignedData structure | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/cms.h> | ||
10 | |||
11 | int CMS_verify(CMS_ContentInfo *cms, STACK_OF(X509) *certs, X509_STORE *store, BIO *indata, BIO *out, unsigned int flags); | ||
12 | |||
13 | STACK_OF(X509) *CMS_get0_signers(CMS_ContentInfo *cms); | ||
14 | |||
15 | =head1 DESCRIPTION | ||
16 | |||
17 | CMS_verify() verifies a CMS SignedData structure. B<cms> is the CMS_ContentInfo | ||
18 | structure to verify. B<certs> is a set of certificates in which to search for | ||
19 | the signing certificate(s). B<store> is a trusted certificate store used for | ||
20 | chain verification. B<indata> is the detached content if the content is not | ||
21 | present in B<cms>. The content is written to B<out> if it is not NULL. | ||
22 | |||
23 | B<flags> is an optional set of flags, which can be used to modify the verify | ||
24 | operation. | ||
25 | |||
26 | CMS_get0_signers() retrieves the signing certificate(s) from B<cms>, it must | ||
27 | be called after a successful CMS_verify() operation. | ||
28 | |||
29 | =head1 VERIFY PROCESS | ||
30 | |||
31 | Normally the verify process proceeds as follows. | ||
32 | |||
33 | Initially some sanity checks are performed on B<cms>. The type of B<cms> must | ||
34 | be SignedData. There must be at least one signature on the data and if | ||
35 | the content is detached B<indata> cannot be B<NULL>. | ||
36 | |||
37 | An attempt is made to locate all the signing certificate(s), first looking in | ||
38 | the B<certs> parameter (if it is not NULL) and then looking in any | ||
39 | certificates contained in the B<cms> structure itself. If any signing | ||
40 | certificate cannot be located the operation fails. | ||
41 | |||
42 | Each signing certificate is chain verified using the B<smimesign> purpose and | ||
43 | the supplied trusted certificate store. Any internal certificates in the message | ||
44 | are used as untrusted CAs. If CRL checking is enabled in B<store> any internal | ||
45 | CRLs are used in addition to attempting to look them up in B<store>. If any | ||
46 | chain verify fails an error code is returned. | ||
47 | |||
48 | Finally the signed content is read (and written to B<out> is it is not NULL) | ||
49 | and the signature's checked. | ||
50 | |||
51 | If all signature's verify correctly then the function is successful. | ||
52 | |||
53 | Any of the following flags (ored together) can be passed in the B<flags> | ||
54 | parameter to change the default verify behaviour. | ||
55 | |||
56 | If B<CMS_NOINTERN> is set the certificates in the message itself are not | ||
57 | searched when locating the signing certificate(s). This means that all the | ||
58 | signing certificates must be in the B<certs> parameter. | ||
59 | |||
60 | If B<CMS_NOCRL> is set and CRL checking is enabled in B<store> then any | ||
61 | CRLs in the message itself are ignored. | ||
62 | |||
63 | If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are deleted | ||
64 | from the content. If the content is not of type B<text/plain> then an error is | ||
65 | returned. | ||
66 | |||
67 | If B<CMS_NO_SIGNER_CERT_VERIFY> is set the signing certificates are not | ||
68 | verified. | ||
69 | |||
70 | If B<CMS_NO_ATTR_VERIFY> is set the signed attributes signature is not | ||
71 | verified. | ||
72 | |||
73 | If B<CMS_NO_CONTENT_VERIFY> is set then the content digest is not checked. | ||
74 | |||
75 | =head1 NOTES | ||
76 | |||
77 | One application of B<CMS_NOINTERN> is to only accept messages signed by | ||
78 | a small number of certificates. The acceptable certificates would be passed | ||
79 | in the B<certs> parameter. In this case if the signer is not one of the | ||
80 | certificates supplied in B<certs> then the verify will fail because the | ||
81 | signer cannot be found. | ||
82 | |||
83 | In some cases the standard techniques for looking up and validating | ||
84 | certificates are not appropriate: for example an application may wish to | ||
85 | lookup certificates in a database or perform customised verification. This | ||
86 | can be achieved by setting and verifying the signers certificates manually | ||
87 | using the signed data utility functions. | ||
88 | |||
89 | Care should be taken when modifying the default verify behaviour, for example | ||
90 | setting B<CMS_NO_CONTENT_VERIFY> will totally disable all content verification | ||
91 | and any modified content will be considered valid. This combination is however | ||
92 | useful if one merely wishes to write the content to B<out> and its validity | ||
93 | is not considered important. | ||
94 | |||
95 | Chain verification should arguably be performed using the signing time rather | ||
96 | than the current time. However since the signing time is supplied by the | ||
97 | signer it cannot be trusted without additional evidence (such as a trusted | ||
98 | timestamp). | ||
99 | |||
100 | =head1 RETURN VALUES | ||
101 | |||
102 | CMS_verify() returns 1 for a successful verification and zero if an error | ||
103 | occurred. | ||
104 | |||
105 | CMS_get0_signers() returns all signers or NULL if an error occurred. | ||
106 | |||
107 | The error can be obtained from L<ERR_get_error(3)|ERR_get_error(3)> | ||
108 | |||
109 | =head1 BUGS | ||
110 | |||
111 | The trusted certificate store is not searched for the signing certificate, | ||
112 | this is primarily due to the inadequacies of the current B<X509_STORE> | ||
113 | functionality. | ||
114 | |||
115 | The lack of single pass processing means that the signed content must all | ||
116 | be held in memory if it is not detached. | ||
117 | |||
118 | =head1 SEE ALSO | ||
119 | |||
120 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_sign(3)|CMS_sign(3)> | ||
121 | |||
122 | =head1 HISTORY | ||
123 | |||
124 | CMS_verify() was added to OpenSSL 0.9.8 | ||
125 | |||
126 | =cut | ||
diff --git a/src/lib/libssl/src/doc/crypto/CMS_verify_receipt.pod b/src/lib/libssl/src/doc/crypto/CMS_verify_receipt.pod deleted file mode 100644 index 2beadda129..0000000000 --- a/src/lib/libssl/src/doc/crypto/CMS_verify_receipt.pod +++ /dev/null | |||
@@ -1,47 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | CMS_verify_receipt - verify a CMS signed receipt | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/cms.h> | ||
10 | |||
11 | int CMS_verify_receipt(CMS_ContentInfo *rcms, CMS_ContentInfo *ocms, STACK_OF(X509) *certs, X509_STORE *store, unsigned int flags); | ||
12 | |||
13 | =head1 DESCRIPTION | ||
14 | |||
15 | CMS_verify_receipt() verifies a CMS signed receipt. B<rcms> is the signed | ||
16 | receipt to verify. B<ocms> is the original SignedData structure containing the | ||
17 | receipt request. B<certs> is a set of certificates in which to search for the | ||
18 | signing certificate. B<store> is a trusted certificate store (used for chain | ||
19 | verification). | ||
20 | |||
21 | B<flags> is an optional set of flags, which can be used to modify the verify | ||
22 | operation. | ||
23 | |||
24 | =head1 NOTES | ||
25 | |||
26 | This functions behaves in a similar way to CMS_verify() except the flag values | ||
27 | B<CMS_DETACHED>, B<CMS_BINARY>, B<CMS_TEXT> and B<CMS_STREAM> are not | ||
28 | supported since they do not make sense in the context of signed receipts. | ||
29 | |||
30 | =head1 RETURN VALUES | ||
31 | |||
32 | CMS_verify_receipt() returns 1 for a successful verification and zero if an | ||
33 | error occurred. | ||
34 | |||
35 | The error can be obtained from L<ERR_get_error(3)|ERR_get_error(3)> | ||
36 | |||
37 | =head1 SEE ALSO | ||
38 | |||
39 | L<ERR_get_error(3)|ERR_get_error(3)>, | ||
40 | L<CMS_sign_receipt(3)|CMS_sign_receipt(3)>, | ||
41 | L<CMS_verify(3)|CMS_verify(3)>, | ||
42 | |||
43 | =head1 HISTORY | ||
44 | |||
45 | CMS_verify_receipt() was added to OpenSSL 0.9.8 | ||
46 | |||
47 | =cut | ||