Skip to content

Add Doxygen documentation for the wolfCrypt PKCS#12 API #11436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kojiws wants to merge 1 commit into
base: master
Choose a base branch
from
+558 −0
Open

Add Doxygen documentation for the wolfCrypt PKCS#12 API #11436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/dox_comments/header_files-ja/doxygen_groups.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,7 @@
\defgroup MD5 アルゴリズム - MD5
\defgroup PKCS7 アルゴリズム - PKCS7
\defgroup PKCS11 アルゴリズム - PKCS11
\defgroup PKCS12 アルゴリズム - PKCS12
\defgroup Password アルゴリズム - パスワードベース
\defgroup Poly1305 アルゴリズム - Poly1305
\defgroup PUF アルゴリズム - PUF
Expand Down
56 changes: 56 additions & 0 deletions doc/dox_comments/header_files-ja/pkcs12.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*!
\ingroup PKCS12
*/
WC_PKCS12* wc_PKCS12_new(void);

/*!
\ingroup PKCS12
*/
WC_PKCS12* wc_PKCS12_new_ex(void* heap);

/*!
\ingroup PKCS12
*/
void wc_PKCS12_free(WC_PKCS12* pkcs12);

/*!
\ingroup PKCS12
*/
int wc_d2i_PKCS12(const byte* der, word32 derSz, WC_PKCS12* pkcs12);

/*!
\ingroup PKCS12
*/
int wc_d2i_PKCS12_fp(const char* file, WC_PKCS12** pkcs12);

/*!
\ingroup PKCS12
*/
int wc_i2d_PKCS12(WC_PKCS12* pkcs12, byte** der, int* derSz);

/*!
\ingroup PKCS12
*/
int wc_PKCS12_parse(WC_PKCS12* pkcs12, const char* psw,
byte** pkey, word32* pkeySz, byte** cert, word32* certSz,
WC_DerCertList** ca);

/*!
\ingroup PKCS12
*/
int wc_PKCS12_parse_ex(WC_PKCS12* pkcs12, const char* psw,
byte** pkey, word32* pkeySz, byte** cert, word32* certSz,
WC_DerCertList** ca, int keepKeyHeader);

/*!
\ingroup PKCS12
*/
WC_PKCS12* wc_PKCS12_create(char* pass, word32 passSz,
char* name, byte* key, word32 keySz, byte* cert, word32 certSz,
WC_DerCertList* ca, int nidKey, int nidCert, int iter, int macIter,
int keyType, void* heap);

/*!
\ingroup PKCS12
*/
void wc_FreeCertList(WC_DerCertList* list, void* heap);
16 changes: 16 additions & 0 deletions doc/dox_comments/header_files/doxygen_groups.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,22 @@
\defgroup PKCS7 Algorithms - PKCS7
\defgroup TSP Time-Stamp Protocol (RFC 3161)
\defgroup PKCS11 Algorithms - PKCS11
\defgroup PKCS12 Algorithms - PKCS12
PKCS #12 (RFC 7292) defines the PFX bundle format, a single password
protected file that carries a private key together with its
certificate and any CA certificates in the chain. It is the format
behind the common .p12 and .pfx files. wolfCrypt support is enabled
with --enable-pkcs12 or by defining HAVE_PKCS12, and also requires
password based key derivation (--enable-pwdbased).

A bundle is read by allocating a WC_PKCS12 structure
(wc_PKCS12_new() or wc_PKCS12_new_ex()), decoding the DER into it
(wc_d2i_PKCS12() or wc_d2i_PKCS12_fp()), then verifying the MAC and
decrypting the contents with wc_PKCS12_parse(), which returns the
DER private key, the certificate, and optionally the CA chain.\n
A bundle is written by building the structure with
wc_PKCS12_create() and encoding it with wc_i2d_PKCS12().\n
See <wolfssl/wolfcrypt/pkcs12.h>.
\defgroup Password Algorithms - Password Based
\defgroup Poly1305 Algorithms - Poly1305
\defgroup PUF Algorithms - PUF
Expand Down
Loading
Loading