summaryrefslogtreecommitdiffstats
path: root/secure/lib/libcrypto/man/pem.3
diff options
context:
space:
mode:
authorsimon <simon@FreeBSD.org>2010-11-22 18:29:00 +0000
committersimon <simon@FreeBSD.org>2010-11-22 18:29:00 +0000
commitbaef74520563dff454420fc45cbb65b465668325 (patch)
tree88ab13e2ea03aedb200603bab91fb927acad16c0 /secure/lib/libcrypto/man/pem.3
parent7a23485c98b888d229c5e0762dbcfcec293fcef6 (diff)
downloadFreeBSD-src-baef74520563dff454420fc45cbb65b465668325.zip
FreeBSD-src-baef74520563dff454420fc45cbb65b465668325.tar.gz
Regenerate manual pages for OpenSSL 0.9.8p.
Diffstat (limited to 'secure/lib/libcrypto/man/pem.3')
-rw-r--r--secure/lib/libcrypto/man/pem.3321
1 files changed, 95 insertions, 226 deletions
diff --git a/secure/lib/libcrypto/man/pem.3 b/secure/lib/libcrypto/man/pem.3
index f8c01c7..9eea580 100644
--- a/secure/lib/libcrypto/man/pem.3
+++ b/secure/lib/libcrypto/man/pem.3
@@ -1,15 +1,7 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.37
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
@@ -25,11 +17,11 @@
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote. | will give a
-.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
-.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
-.\" expand to `' in nroff, nothing in troff, for use with C<>.
-.tr \(*W-|\(bv\*(Tr
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
@@ -48,22 +40,25 @@
. ds R" ''
'br\}
.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
-.if \nF \{\
+.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
-.\"
-.\" For nroff, turn off justification. Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+. de IX
+..
+.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
@@ -129,306 +124,186 @@
.\" ========================================================================
.\"
.IX Title "pem 3"
-.TH pem 3 "2010-03-24" "0.9.8n" "OpenSSL"
+.TH pem 3 "2010-11-16" "0.9.8p" "OpenSSL"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
.SH "NAME"
PEM, PEM_read_bio_PrivateKey, PEM_read_PrivateKey, PEM_write_bio_PrivateKey, PEM_write_PrivateKey, PEM_write_bio_PKCS8PrivateKey, PEM_write_PKCS8PrivateKey, PEM_write_bio_PKCS8PrivateKey_nid, PEM_write_PKCS8PrivateKey_nid, PEM_read_bio_PUBKEY, PEM_read_PUBKEY, PEM_write_bio_PUBKEY, PEM_write_PUBKEY, PEM_read_bio_RSAPrivateKey, PEM_read_RSAPrivateKey, PEM_write_bio_RSAPrivateKey, PEM_write_RSAPrivateKey, PEM_read_bio_RSAPublicKey, PEM_read_RSAPublicKey, PEM_write_bio_RSAPublicKey, PEM_write_RSAPublicKey, PEM_read_bio_RSA_PUBKEY, PEM_read_RSA_PUBKEY, PEM_write_bio_RSA_PUBKEY, PEM_write_RSA_PUBKEY, PEM_read_bio_DSAPrivateKey, PEM_read_DSAPrivateKey, PEM_write_bio_DSAPrivateKey, PEM_write_DSAPrivateKey, PEM_read_bio_DSA_PUBKEY, PEM_read_DSA_PUBKEY, PEM_write_bio_DSA_PUBKEY, PEM_write_DSA_PUBKEY, PEM_read_bio_DSAparams, PEM_read_DSAparams, PEM_write_bio_DSAparams, PEM_write_DSAparams, PEM_read_bio_DHparams, PEM_read_DHparams, PEM_write_bio_DHparams, PEM_write_DHparams, PEM_read_bio_X509, PEM_read_X509, PEM_write_bio_X509, PEM_write_X509, PEM_read_bio_X509_AUX, PEM_read_X509_AUX, PEM_write_bio_X509_AUX, PEM_write_X509_AUX, PEM_read_bio_X509_REQ, PEM_read_X509_REQ, PEM_write_bio_X509_REQ, PEM_write_X509_REQ, PEM_write_bio_X509_REQ_NEW, PEM_write_X509_REQ_NEW, PEM_read_bio_X509_CRL, PEM_read_X509_CRL, PEM_write_bio_X509_CRL, PEM_write_X509_CRL, PEM_read_bio_PKCS7, PEM_read_PKCS7, PEM_write_bio_PKCS7, PEM_write_PKCS7, PEM_read_bio_NETSCAPE_CERT_SEQUENCE, PEM_read_NETSCAPE_CERT_SEQUENCE, PEM_write_bio_NETSCAPE_CERT_SEQUENCE, PEM_write_NETSCAPE_CERT_SEQUENCE \- PEM routines
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/pem.h>
-.Ve
-.PP
-.Vb 2
+\&
\& EVP_PKEY *PEM_read_bio_PrivateKey(BIO *bp, EVP_PKEY **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 2
+\&
\& EVP_PKEY *PEM_read_PrivateKey(FILE *fp, EVP_PKEY **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 3
+\&
\& int PEM_write_bio_PrivateKey(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc,
\& unsigned char *kstr, int klen,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 3
+\&
\& int PEM_write_PrivateKey(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
\& unsigned char *kstr, int klen,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 3
+\&
\& int PEM_write_bio_PKCS8PrivateKey(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc,
\& char *kstr, int klen,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 3
+\&
\& int PEM_write_PKCS8PrivateKey(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
\& char *kstr, int klen,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 3
+\&
\& int PEM_write_bio_PKCS8PrivateKey_nid(BIO *bp, EVP_PKEY *x, int nid,
\& char *kstr, int klen,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 3
+\&
\& int PEM_write_PKCS8PrivateKey_nid(FILE *fp, EVP_PKEY *x, int nid,
\& char *kstr, int klen,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 2
+\&
\& EVP_PKEY *PEM_read_bio_PUBKEY(BIO *bp, EVP_PKEY **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 2
+\&
\& EVP_PKEY *PEM_read_PUBKEY(FILE *fp, EVP_PKEY **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 2
+\&
\& int PEM_write_bio_PUBKEY(BIO *bp, EVP_PKEY *x);
\& int PEM_write_PUBKEY(FILE *fp, EVP_PKEY *x);
-.Ve
-.PP
-.Vb 2
+\&
\& RSA *PEM_read_bio_RSAPrivateKey(BIO *bp, RSA **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 2
+\&
\& RSA *PEM_read_RSAPrivateKey(FILE *fp, RSA **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 3
+\&
\& int PEM_write_bio_RSAPrivateKey(BIO *bp, RSA *x, const EVP_CIPHER *enc,
\& unsigned char *kstr, int klen,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 3
+\&
\& int PEM_write_RSAPrivateKey(FILE *fp, RSA *x, const EVP_CIPHER *enc,
\& unsigned char *kstr, int klen,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 2
+\&
\& RSA *PEM_read_bio_RSAPublicKey(BIO *bp, RSA **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 2
+\&
\& RSA *PEM_read_RSAPublicKey(FILE *fp, RSA **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_bio_RSAPublicKey(BIO *bp, RSA *x);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_RSAPublicKey(FILE *fp, RSA *x);
-.Ve
-.PP
-.Vb 2
+\&
\& RSA *PEM_read_bio_RSA_PUBKEY(BIO *bp, RSA **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 2
+\&
\& RSA *PEM_read_RSA_PUBKEY(FILE *fp, RSA **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_bio_RSA_PUBKEY(BIO *bp, RSA *x);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_RSA_PUBKEY(FILE *fp, RSA *x);
-.Ve
-.PP
-.Vb 2
+\&
\& DSA *PEM_read_bio_DSAPrivateKey(BIO *bp, DSA **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 2
+\&
\& DSA *PEM_read_DSAPrivateKey(FILE *fp, DSA **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 3
+\&
\& int PEM_write_bio_DSAPrivateKey(BIO *bp, DSA *x, const EVP_CIPHER *enc,
\& unsigned char *kstr, int klen,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 3
+\&
\& int PEM_write_DSAPrivateKey(FILE *fp, DSA *x, const EVP_CIPHER *enc,
\& unsigned char *kstr, int klen,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 2
+\&
\& DSA *PEM_read_bio_DSA_PUBKEY(BIO *bp, DSA **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 2
+\&
\& DSA *PEM_read_DSA_PUBKEY(FILE *fp, DSA **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_bio_DSA_PUBKEY(BIO *bp, DSA *x);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_DSA_PUBKEY(FILE *fp, DSA *x);
-.Ve
-.PP
-.Vb 1
+\&
\& DSA *PEM_read_bio_DSAparams(BIO *bp, DSA **x, pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& DSA *PEM_read_DSAparams(FILE *fp, DSA **x, pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_bio_DSAparams(BIO *bp, DSA *x);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_DSAparams(FILE *fp, DSA *x);
-.Ve
-.PP
-.Vb 1
+\&
\& DH *PEM_read_bio_DHparams(BIO *bp, DH **x, pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& DH *PEM_read_DHparams(FILE *fp, DH **x, pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_bio_DHparams(BIO *bp, DH *x);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_DHparams(FILE *fp, DH *x);
-.Ve
-.PP
-.Vb 1
+\&
\& X509 *PEM_read_bio_X509(BIO *bp, X509 **x, pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& X509 *PEM_read_X509(FILE *fp, X509 **x, pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_bio_X509(BIO *bp, X509 *x);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_X509(FILE *fp, X509 *x);
-.Ve
-.PP
-.Vb 1
+\&
\& X509 *PEM_read_bio_X509_AUX(BIO *bp, X509 **x, pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& X509 *PEM_read_X509_AUX(FILE *fp, X509 **x, pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_bio_X509_AUX(BIO *bp, X509 *x);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_X509_AUX(FILE *fp, X509 *x);
-.Ve
-.PP
-.Vb 2
+\&
\& X509_REQ *PEM_read_bio_X509_REQ(BIO *bp, X509_REQ **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 2
+\&
\& X509_REQ *PEM_read_X509_REQ(FILE *fp, X509_REQ **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_bio_X509_REQ(BIO *bp, X509_REQ *x);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_X509_REQ(FILE *fp, X509_REQ *x);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_bio_X509_REQ_NEW(BIO *bp, X509_REQ *x);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_X509_REQ_NEW(FILE *fp, X509_REQ *x);
-.Ve
-.PP
-.Vb 6
+\&
\& X509_CRL *PEM_read_bio_X509_CRL(BIO *bp, X509_CRL **x,
\& pem_password_cb *cb, void *u);
\& X509_CRL *PEM_read_X509_CRL(FILE *fp, X509_CRL **x,
\& pem_password_cb *cb, void *u);
\& int PEM_write_bio_X509_CRL(BIO *bp, X509_CRL *x);
\& int PEM_write_X509_CRL(FILE *fp, X509_CRL *x);
-.Ve
-.PP
-.Vb 1
+\&
\& PKCS7 *PEM_read_bio_PKCS7(BIO *bp, PKCS7 **x, pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& PKCS7 *PEM_read_PKCS7(FILE *fp, PKCS7 **x, pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_bio_PKCS7(BIO *bp, PKCS7 *x);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_PKCS7(FILE *fp, PKCS7 *x);
-.Ve
-.PP
-.Vb 3
+\&
\& NETSCAPE_CERT_SEQUENCE *PEM_read_bio_NETSCAPE_CERT_SEQUENCE(BIO *bp,
\& NETSCAPE_CERT_SEQUENCE **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 3
+\&
\& NETSCAPE_CERT_SEQUENCE *PEM_read_NETSCAPE_CERT_SEQUENCE(FILE *fp,
\& NETSCAPE_CERT_SEQUENCE **x,
\& pem_password_cb *cb, void *u);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_bio_NETSCAPE_CERT_SEQUENCE(BIO *bp, NETSCAPE_CERT_SEQUENCE *x);
-.Ve
-.PP
-.Vb 1
+\&
\& int PEM_write_NETSCAPE_CERT_SEQUENCE(FILE *fp, NETSCAPE_CERT_SEQUENCE *x);
.Ve
.SH "DESCRIPTION"
@@ -503,7 +378,7 @@ structure. They will also process a trusted X509 certificate but
any trust settings are discarded.
.PP
The \fBX509_AUX\fR functions process a trusted X509 certificate using
-an X509 structure.
+an X509 structure.
.PP
The \fBX509_REQ\fR and \fBX509_REQ_NEW\fR functions process a PKCS#10
certificate request using an X509_REQ structure. The \fBX509_REQ\fR
@@ -666,17 +541,13 @@ Skeleton pass phrase callback:
\& {
\& int len;
\& char *tmp;
-\& /* We'd probably do something else if 'rwflag' is 1 */
+\& /* We\*(Aqd probably do something else if \*(Aqrwflag\*(Aq is 1 */
\& printf("Enter pass phrase for \e"%s\e"\en", u);
-.Ve
-.PP
-.Vb 3
-\& /* get pass phrase, length 'len' into 'tmp' */
+\&
+\& /* get pass phrase, length \*(Aqlen\*(Aq into \*(Aqtmp\*(Aq */
\& tmp = "hello";
\& len = strlen(tmp);
-.Ve
-.PP
-.Vb 6
+\&
\& if (len <= 0) return 0;
\& /* if too long, truncate */
\& if (len > size) len = size;
@@ -710,17 +581,15 @@ which is an uninitialised pointer.
.IX Header "PEM ENCRYPTION FORMAT"
This old \fBPrivateKey\fR routines use a non standard technique for encryption.
.PP
-The private key (or other data) takes the following form:
+The private key (or other data) takes the following form:
.PP
.Vb 3
-\& -----BEGIN RSA PRIVATE KEY-----
-\& Proc-Type: 4,ENCRYPTED
-\& DEK-Info: DES-EDE3-CBC,3F17F5316E2BAC89
-.Ve
-.PP
-.Vb 2
+\& \-\-\-\-\-BEGIN RSA PRIVATE KEY\-\-\-\-\-
+\& Proc\-Type: 4,ENCRYPTED
+\& DEK\-Info: DES\-EDE3\-CBC,3F17F5316E2BAC89
+\&
\& ...base64 encoded data...
-\& -----END RSA PRIVATE KEY-----
+\& \-\-\-\-\-END RSA PRIVATE KEY\-\-\-\-\-
.Ve
.PP
The line beginning DEK-Info contains two comma separated pieces of information:
@@ -741,7 +610,7 @@ an existing structure. Therefore the following:
\& PEM_read_bio_X509(bp, &x, 0, NULL);
.Ve
.PP
-where \fBx\fR already contains a valid certificate, may not work, whereas:
+where \fBx\fR already contains a valid certificate, may not work, whereas:
.PP
.Vb 2
\& X509_free(x);
OpenPOWER on IntegriCloud