← Back to branch summary

~ubuntu-branches/ubuntu/hardy/openssl/hardy-security

« back to all changes in this revision

Viewing changes to doc/crypto/d2i_PKCS8PrivateKey.pod

  • Committer: Bazaar Package Importer
  • Author(s): Christoph Martin
  • Date: 2004-05-24 17:02:29 UTC
  • Revision ID: james.westby@ubuntu.com-20040524170229-ixlo08bbbly0xied
Tags: upstream-0.9.7d
Import upstream version 0.9.7d

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/crypto/d2i_PKCS8PrivateKey.pod
 
1
=pod
 
2
 
 
3
=head1 NAME
 
4
 
 
5
d2i_PKCS8PrivateKey_bio, d2i_PKCS8PrivateKey_fp,
 
6
i2d_PKCS8PrivateKey_bio, i2d_PKCS8PrivateKey_fp,
 
7
i2d_PKCS8PrivateKey_nid_bio, i2d_PKCS8PrivateKey_nid_fp - PKCS#8 format private key functions
 
8
 
 
9
=head1 SYNOPSIS
 
10
 
 
11
 #include <openssl/evp.h>
 
12
 
 
13
 EVP_PKEY *d2i_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY **x, pem_password_cb *cb, void *u);
 
14
 EVP_PKEY *d2i_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY **x, pem_password_cb *cb, void *u);
 
15
 
 
16
 int i2d_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc,
 
17
                                  char *kstr, int klen,
 
18
                                  pem_password_cb *cb, void *u);
 
19
 
 
20
 int i2d_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
 
21
                                  char *kstr, int klen,
 
22
                                  pem_password_cb *cb, void *u);
 
23
 
 
24
 int i2d_PKCS8PrivateKey_nid_bio(BIO *bp, EVP_PKEY *x, int nid,
 
25
                                  char *kstr, int klen,
 
26
                                  pem_password_cb *cb, void *u);
 
27
 
 
28
 int i2d_PKCS8PrivateKey_nid_fp(FILE *fp, EVP_PKEY *x, int nid,
 
29
                                  char *kstr, int klen,
 
30
                                  pem_password_cb *cb, void *u);
 
31
 
 
32
=head1 DESCRIPTION
 
33
 
 
34
The PKCS#8 functions encode and decode private keys in PKCS#8 format using both
 
35
PKCS#5 v1.5 and PKCS#5 v2.0 password based encryption algorithms.
 
36
 
 
37
Other than the use of DER as opposed to PEM these functions are identical to the
 
38
corresponding B<PEM> function as described in the L<pem(3)|pem(3)> manual page.
 
39
 
 
40
=head1 NOTES
 
41
 
 
42
Before using these functions L<OpenSSL_add_all_algorithms(3)|OpenSSL_add_all_algorithms(3)>
 
43
should be called to initialize the internal algorithm lookup tables otherwise errors about
 
44
unknown algorithms will occur if an attempt is made to decrypt a private key. 
 
45
 
 
46
These functions are currently the only way to store encrypted private keys using DER format.
 
47
 
 
48
Currently all the functions use BIOs or FILE pointers, there are no functions which
 
49
work directly on memory: this can be readily worked around by converting the buffers
 
50
to memory BIOs, see L<BIO_s_mem(3)|BIO_s_mem(3)> for details.
 
51
 
 
52
=head1 SEE ALSO
 
53
 
 
54
L<pem(3)|pem(3)>
 
55
 
 
56
=cut