diff options
Diffstat (limited to 'docs/api/tmpl/nss')
-rw-r--r-- | docs/api/tmpl/nss/app.sgml | 247 | ||||
-rw-r--r-- | docs/api/tmpl/nss/bignum.sgml | 44 | ||||
-rw-r--r-- | docs/api/tmpl/nss/crypto.sgml | 653 | ||||
-rw-r--r-- | docs/api/tmpl/nss/keysstore.sgml | 70 | ||||
-rw-r--r-- | docs/api/tmpl/nss/pkikeys.sgml | 69 | ||||
-rw-r--r-- | docs/api/tmpl/nss/x509.sgml | 192 | ||||
-rw-r--r-- | docs/api/tmpl/nss/xmlsec-nss-unused.sgml | 8 |
7 files changed, 1283 insertions, 0 deletions
diff --git a/docs/api/tmpl/nss/app.sgml b/docs/api/tmpl/nss/app.sgml new file mode 100644 index 00000000..16cbcfbe --- /dev/null +++ b/docs/api/tmpl/nss/app.sgml @@ -0,0 +1,247 @@ +<!-- ##### SECTION Title ##### --> +app + +<!-- ##### SECTION Short_Description ##### --> +Application functions implementation for NSS. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Application functions implementation for NSS. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION xmlSecNssAppInit ##### --> +<para> + +</para> + +@config: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppShutdown ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppDefaultKeysMngrInit ##### --> +<para> + +</para> + +@mngr: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppDefaultKeysMngrAdoptKey ##### --> +<para> + +</para> + +@mngr: +@key: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppDefaultKeysMngrLoad ##### --> +<para> + +</para> + +@mngr: +@uri: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppDefaultKeysMngrSave ##### --> +<para> + +</para> + +@mngr: +@filename: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppKeysMngrCertLoad ##### --> +<para> + +</para> + +@mngr: +@filename: +@format: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppKeysMngrCertLoadMemory ##### --> +<para> + +</para> + +@mngr: +@data: +@dataSize: +@format: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppKeysMngrCertLoadSECItem ##### --> +<para> + +</para> + +@mngr: +@secItem: +@format: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppKeyLoad ##### --> +<para> + +</para> + +@filename: +@format: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppKeyLoadMemory ##### --> +<para> + +</para> + +@data: +@dataSize: +@format: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppKeyLoadSECItem ##### --> +<para> + +</para> + +@secItem: +@format: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppPkcs12Load ##### --> +<para> + +</para> + +@filename: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppPkcs12LoadMemory ##### --> +<para> + +</para> + +@data: +@dataSize: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppPkcs12LoadSECItem ##### --> +<para> + +</para> + +@secItem: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppKeyCertLoad ##### --> +<para> + +</para> + +@key: +@filename: +@format: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppKeyCertLoadMemory ##### --> +<para> + +</para> + +@key: +@data: +@dataSize: +@format: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppKeyCertLoadSECItem ##### --> +<para> + +</para> + +@key: +@secItem: +@format: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppKeyFromCertLoadSECItem ##### --> +<para> + +</para> + +@secItem: +@format: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssAppGetDefaultPwdCallback ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/api/tmpl/nss/bignum.sgml b/docs/api/tmpl/nss/bignum.sgml new file mode 100644 index 00000000..cd8b2b26 --- /dev/null +++ b/docs/api/tmpl/nss/bignum.sgml @@ -0,0 +1,44 @@ +<!-- ##### SECTION Title ##### --> +bignum + +<!-- ##### SECTION Short_Description ##### --> +Big numbers helper functions. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Big numbers helper functions. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION xmlSecNssNodeGetBigNumValue ##### --> +<para> + +</para> + +@arena: +@cur: +@a: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssNodeSetBigNumValue ##### --> +<para> + +</para> + +@cur: +@a: +@addLineBreaks: +@Returns: + + diff --git a/docs/api/tmpl/nss/crypto.sgml b/docs/api/tmpl/nss/crypto.sgml new file mode 100644 index 00000000..6e625dbd --- /dev/null +++ b/docs/api/tmpl/nss/crypto.sgml @@ -0,0 +1,653 @@ +<!-- ##### SECTION Title ##### --> +crypto + +<!-- ##### SECTION Short_Description ##### --> +Crypto transforms implementation for NSS. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Crypto transforms implementation for NSS. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION xmlSecCryptoGetFunctions_nss ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssInit ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssShutdown ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeysMngrInit ##### --> +<para> + +</para> + +@mngr: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssGenerateRandom ##### --> +<para> + +</para> + +@buffer: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssErrorsDefaultCallback ##### --> +<para> + +</para> + +@file: +@line: +@func: +@errorObject: +@errorSubject: +@reason: +@msg: + + +<!-- ##### FUNCTION xmlSecNssGetInternalKeySlot ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssKeyDataAesId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssKeyDataAesGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeyDataAesSet ##### --> +<para> + +</para> + +@data: +@buf: +@bufSize: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformAes128CbcId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformAes128CbcGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformAes192CbcId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformAes192CbcGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformAes256CbcId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformAes256CbcGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformKWAes128Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformKWAes128GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformKWAes192Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformKWAes192GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformKWAes256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformKWAes256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssKeyDataDesId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssKeyDataDesGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeyDataDesSet ##### --> +<para> + +</para> + +@data: +@buf: +@bufSize: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformDes3CbcId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformDes3CbcGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformKWDes3Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformKWDes3GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssKeyDataDsaId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssKeyDataDsaGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformDsaSha1Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformDsaSha1GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssHmacGetMinOutputLength ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssHmacSetMinOutputLength ##### --> +<para> + +</para> + +@min_length: + + +<!-- ##### MACRO xmlSecNssKeyDataHmacId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssKeyDataHmacGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeyDataHmacSet ##### --> +<para> + +</para> + +@data: +@buf: +@bufSize: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformHmacMd5Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformHmacMd5GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformHmacRipemd160Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformHmacRipemd160GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformHmacSha1Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformHmacSha1GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformHmacSha256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformHmacSha256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformHmacSha384Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformHmacSha384GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformHmacSha512Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformHmacSha512GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssKeyDataRsaId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssKeyDataRsaGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformRsaMd5Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformRsaMd5GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformRsaSha1Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformRsaSha1GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformRsaSha256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformRsaSha256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformRsaSha384Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformRsaSha384GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformRsaSha512Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformRsaSha512GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformRsaPkcs1Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformRsaPkcs1GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformRsaOaepId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformRsaOaepGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformSha1Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformSha1GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformSha256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformSha256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformSha384Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformSha384GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformSha512Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformSha512GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssTransformMd5Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssTransformMd5GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/api/tmpl/nss/keysstore.sgml b/docs/api/tmpl/nss/keysstore.sgml new file mode 100644 index 00000000..fef83967 --- /dev/null +++ b/docs/api/tmpl/nss/keysstore.sgml @@ -0,0 +1,70 @@ +<!-- ##### SECTION Title ##### --> +keysstore + +<!-- ##### SECTION Short_Description ##### --> +Keys store implementation for NSS. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Keys store implementation for NSS. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO xmlSecNssKeysStoreId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssKeysStoreGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeysStoreAdoptKey ##### --> +<para> + +</para> + +@store: +@key: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeysStoreLoad ##### --> +<para> + +</para> + +@store: +@uri: +@keysMngr: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeysStoreSave ##### --> +<para> + +</para> + +@store: +@filename: +@type: +@Returns: + + diff --git a/docs/api/tmpl/nss/pkikeys.sgml b/docs/api/tmpl/nss/pkikeys.sgml new file mode 100644 index 00000000..8541a552 --- /dev/null +++ b/docs/api/tmpl/nss/pkikeys.sgml @@ -0,0 +1,69 @@ +<!-- ##### SECTION Title ##### --> +pkikeys + +<!-- ##### SECTION Short_Description ##### --> +PKI keys data implementation. + +<!-- ##### SECTION Long_Description ##### --> +<para> +PKI keys data implementation. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION xmlSecNssPKIAdoptKey ##### --> +<para> + +</para> + +@privkey: +@pubkey: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssPKIKeyDataGetPubKey ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssPKIKeyDataGetPrivKey ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssPKIKeyDataGetKeyType ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssPKIKeyDataDuplicate ##### --> +<para> + +</para> + +@dst: +@src: +@Returns: + + diff --git a/docs/api/tmpl/nss/x509.sgml b/docs/api/tmpl/nss/x509.sgml new file mode 100644 index 00000000..e897bc0d --- /dev/null +++ b/docs/api/tmpl/nss/x509.sgml @@ -0,0 +1,192 @@ +<!-- ##### SECTION Title ##### --> +x509 + +<!-- ##### SECTION Short_Description ##### --> +X509 certificates support implementation for NSS. + +<!-- ##### SECTION Long_Description ##### --> +<para> +X509 certificates support implementation for NSS. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO xmlSecNssKeyDataX509Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssKeyDataX509GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeyDataX509GetKeyCert ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeyDataX509AdoptKeyCert ##### --> +<para> + +</para> + +@data: +@cert: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeyDataX509AdoptCert ##### --> +<para> + +</para> + +@data: +@cert: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeyDataX509GetCert ##### --> +<para> + +</para> + +@data: +@pos: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeyDataX509GetCertsSize ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeyDataX509AdoptCrl ##### --> +<para> + +</para> + +@data: +@crl: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeyDataX509GetCrl ##### --> +<para> + +</para> + +@data: +@pos: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssKeyDataX509GetCrlsSize ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssX509CertGetKey ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### MACRO xmlSecNssKeyDataRawX509CertId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssKeyDataRawX509CertGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecNssX509StoreId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecNssX509StoreGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssX509StoreFindCert ##### --> +<para> + +</para> + +@store: +@subjectName: +@issuerName: +@issuerSerial: +@ski: +@keyInfoCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssX509StoreVerify ##### --> +<para> + +</para> + +@store: +@certs: +@keyInfoCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecNssX509StoreAdoptCert ##### --> +<para> + +</para> + +@store: +@cert: +@type: +@Returns: + + diff --git a/docs/api/tmpl/nss/xmlsec-nss-unused.sgml b/docs/api/tmpl/nss/xmlsec-nss-unused.sgml new file mode 100644 index 00000000..37646687 --- /dev/null +++ b/docs/api/tmpl/nss/xmlsec-nss-unused.sgml @@ -0,0 +1,8 @@ +<!-- ##### SECTION ./tmpl/nss/xmlsec-nss-unused.sgml:Image ##### --> + + + +<!-- ##### SECTION tmpl/nss/xmlsec-nss-unused.sgml:Image ##### --> + + + |