app

Home Download News Documentation FAQ Tutorial API reference Examples XML Digital Signature Online Verifier XML Encryption XML Canonicalization Reporting Bugs Mailing list Related
XML Security Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>
# app ## Name app -- ## Synopsis
    int         xmlSecNssAppInit                (const char *config);
    int         xmlSecNssAppShutdown            (void);
    int         xmlSecNssAppDefaultKeysMngrInit (xmlSecKeysMngrPtr mngr);
    int         xmlSecNssAppDefaultKeysMngrAdoptKey
                                                (xmlSecKeysMngrPtr mngr,
                                                 xmlSecKeyPtr key);
    int         xmlSecNssAppDefaultKeysMngrLoad (xmlSecKeysMngrPtr mngr,
                                                 const char *uri);
    int         xmlSecNssAppDefaultKeysMngrSave (xmlSecKeysMngrPtr mngr,
                                                 const char *filename,
                                                 xmlSecKeyDataType type);
    int         xmlSecNssAppKeysMngrCertLoad    (xmlSecKeysMngrPtr mngr,
                                                 const char *filename,
                                                 xmlSecKeyDataFormat format,
                                                 xmlSecKeyDataType type);
    int         xmlSecNssAppKeysMngrAddCertsPath
                                                (xmlSecKeysMngrPtr mngr,
                                                 const char *path);
    xmlSecKeyPtr xmlSecNssAppKeyLoad            (const char *filename,
                                                 xmlSecKeyDataFormat format,
                                                 const char *pwd,
                                                 void *pwdCallback,
                                                 void *pwdCallbackCtx);
    xmlSecKeyPtr xmlSecNssAppPkcs12Load         (const char *filename,
                                                 const char *pwd,
                                                 void *pwdCallback,
                                                 void *pwdCallbackCtx);
    int         xmlSecNssAppKeyCertLoad         (xmlSecKeyPtr key,
                                                 const char *filename,
                                                 xmlSecKeyDataFormat format);
## Description ## Details ### xmlSecNssAppInit ()
    int         xmlSecNssAppInit                (const char *config);
General crypto engine initialization. This function is used by XMLSec command line utility and called before `xmlSecInit` function.
`config` : | the path to NSS database files.
Returns : | 0 on success or a negative value otherwise.
### xmlSecNssAppShutdown ()
    int         xmlSecNssAppShutdown            (void);
General crypto engine shutdown. This function is used by XMLSec command line utility and called after `xmlSecShutdown` function.
Returns : | 0 on success or a negative value otherwise.
### xmlSecNssAppDefaultKeysMngrInit ()
    int         xmlSecNssAppDefaultKeysMngrInit (xmlSecKeysMngrPtr mngr);
Initializes `mngr` with simple keys store xmlSecSimpleKeysStoreId and a default NSS crypto key data stores.
`mngr` : | the pointer to keys manager.
Returns : | 0 on success or a negative value otherwise.
### xmlSecNssAppDefaultKeysMngrAdoptKey ()
    int         xmlSecNssAppDefaultKeysMngrAdoptKey
                                                (xmlSecKeysMngrPtr mngr,
                                                 xmlSecKeyPtr key);
Adds `key` to the keys manager `mngr` created with xmlSecNssAppDefaultKeysMngrInit function.
`mngr` : | the pointer to keys manager.
`key` : | the pointer to key.
Returns : | 0 on success or a negative value otherwise.
### xmlSecNssAppDefaultKeysMngrLoad ()
    int         xmlSecNssAppDefaultKeysMngrLoad (xmlSecKeysMngrPtr mngr,
                                                 const char *uri);
Loads XML keys file from `uri` to the keys manager `mngr` created with xmlSecNssAppDefaultKeysMngrInit function.
`mngr` : | the pointer to keys manager.
`uri` : | the uri.
Returns : | 0 on success or a negative value otherwise.
### xmlSecNssAppDefaultKeysMngrSave ()
    int         xmlSecNssAppDefaultKeysMngrSave (xmlSecKeysMngrPtr mngr,
                                                 const char *filename,
                                                 xmlSecKeyDataType type);
Saves keys from `mngr` to XML keys file.
`mngr` : | the pointer to keys manager.
`filename` : | the destination filename.
`type` : | the type of keys to save (public/private/symmetric).
Returns : | 0 on success or a negative value otherwise.
### xmlSecNssAppKeysMngrCertLoad ()
    int         xmlSecNssAppKeysMngrCertLoad    (xmlSecKeysMngrPtr mngr,
                                                 const char *filename,
                                                 xmlSecKeyDataFormat format,
                                                 xmlSecKeyDataType type);
Reads cert from PEM `filename` and adds to the list of trusted or known untrusted certs in `store` (not implemented yet).
`mngr` : | the pointer to keys manager.
`filename` : | the certificate file.
`format` : | the certificate file format (PEM or DER).
`type` : | the certificate type (trusted/untrusted).
Returns : | 0 on success or a negative value otherwise.
### xmlSecNssAppKeysMngrAddCertsPath ()
    int         xmlSecNssAppKeysMngrAddCertsPath
                                                (xmlSecKeysMngrPtr mngr,
                                                 const char *path);
Reads cert from `path` and adds to the list of trusted certificates (not implemented yet).
`mngr` : | the keys manager.
`path` : | the path to trusted certificates.
Returns : | 0 on success or a negative value otherwise.
### xmlSecNssAppKeyLoad ()
    xmlSecKeyPtr xmlSecNssAppKeyLoad            (const char *filename,
                                                 xmlSecKeyDataFormat format,
                                                 const char *pwd,
                                                 void *pwdCallback,
                                                 void *pwdCallbackCtx);
Reads key from the a file (not implemented yet).
`filename` : | the key filename.
`format` : | the key file format.
`pwd` : | the PEM key file password.
`pwdCallback` : | the PEM key password callback.
`pwdCallbackCtx` : | the user context for password callback.
Returns : | pointer to the key or NULL if an error occurs.
### xmlSecNssAppPkcs12Load ()
    xmlSecKeyPtr xmlSecNssAppPkcs12Load         (const char *filename,
                                                 const char *pwd,
                                                 void *pwdCallback,
                                                 void *pwdCallbackCtx);
Reads key and all associated certificates from the PKCS12 file (not implemented yet).
`filename` : | the PKCS12 key filename.
`pwd` : | the PKCS12 file password.
`pwdCallback` : | the password callback.
`pwdCallbackCtx` : | the user context for password callback.
Returns : | pointer to the key or NULL if an error occurs.
### xmlSecNssAppKeyCertLoad ()
    int         xmlSecNssAppKeyCertLoad         (xmlSecKeyPtr key,
                                                 const char *filename,
                                                 xmlSecKeyDataFormat format);
Reads the certificate from $`filename` and adds it to key (not implemented yet).
`key` : | the pointer to key.
`filename` : | the certificate filename.
`format` : | the certificate file format.
Returns : | 0 on success or a negative value otherwise.
<<< Previous Page | Home | Up | Next Page >>>
XML Security Library for NSS API Reference. | crypto
Aleksey Sanin