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         xmlSecOpenSSLAppInit            (const char *config);
    int         xmlSecOpenSSLAppShutdown        (void);
    int         xmlSecOpenSSLAppDefaultKeysMngrInit
                                                (xmlSecKeysMngrPtr mngr);
    int         xmlSecOpenSSLAppDefaultKeysMngrAdoptKey
                                                (xmlSecKeysMngrPtr mngr,
                                                 xmlSecKeyPtr key);
    int         xmlSecOpenSSLAppDefaultKeysMngrLoad
                                                (xmlSecKeysMngrPtr mngr,
                                                 const char *uri);
    int         xmlSecOpenSSLAppDefaultKeysMngrSave
                                                (xmlSecKeysMngrPtr mngr,
                                                 const char *filename,
                                                 xmlSecKeyDataType type);
    int         xmlSecOpenSSLAppKeysMngrCertLoad
                                                (xmlSecKeysMngrPtr mngr,
                                                 const char *filename,
                                                 xmlSecKeyDataFormat format,
                                                 xmlSecKeyDataType type);
    int         xmlSecOpenSSLAppKeysMngrAddCertsPath
                                                (xmlSecKeysMngrPtr mngr,
                                                 const char *path);
    xmlSecKeyPtr xmlSecOpenSSLAppKeyLoad        (const char *filename,
                                                 xmlSecKeyDataFormat format,
                                                 const char *pwd,
                                                 pem_password_cb *pwdCallback,
                                                 void *pwdCallbackCtx);
    xmlSecKeyPtr xmlSecOpenSSLAppPkcs12Load     (const char *filename,
                                                 const char *pwd,
                                                 pem_password_cb *pwdCallback,
                                                 void *pwdCallbackCtx);
    int         xmlSecOpenSSLAppKeyCertLoad     (xmlSecKeyPtr key,
                                                 const char *filename,
                                                 xmlSecKeyDataFormat format);
## Description ## Details ### xmlSecOpenSSLAppInit ()
    int         xmlSecOpenSSLAppInit            (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 crypto library configuration (unused).
Returns : | 0 on success or a negative value otherwise.
### xmlSecOpenSSLAppShutdown ()
    int         xmlSecOpenSSLAppShutdown        (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.
### xmlSecOpenSSLAppDefaultKeysMngrInit ()
    int         xmlSecOpenSSLAppDefaultKeysMngrInit
                                                (xmlSecKeysMngrPtr mngr);
Initializes `mngr` with simple keys store xmlSecSimpleKeysStoreId and a default OpenSSL crypto key data stores.
`mngr` : | the pointer to keys manager.
Returns : | 0 on success or a negative value otherwise.
### xmlSecOpenSSLAppDefaultKeysMngrAdoptKey ()
    int         xmlSecOpenSSLAppDefaultKeysMngrAdoptKey
                                                (xmlSecKeysMngrPtr mngr,
                                                 xmlSecKeyPtr key);
Adds `key` to the keys manager `mngr` created with xmlSecOpenSSLAppDefaultKeysMngrInit function.
`mngr` : | the pointer to keys manager.
`key` : | the pointer to key.
Returns : | 0 on success or a negative value otherwise.
### xmlSecOpenSSLAppDefaultKeysMngrLoad ()
    int         xmlSecOpenSSLAppDefaultKeysMngrLoad
                                                (xmlSecKeysMngrPtr mngr,
                                                 const char *uri);
Loads XML keys file from `uri` to the keys manager `mngr` created with xmlSecOpenSSLAppDefaultKeysMngrInit function.
`mngr` : | the pointer to keys manager.
`uri` : | the uri.
Returns : | 0 on success or a negative value otherwise.
### xmlSecOpenSSLAppDefaultKeysMngrSave ()
    int         xmlSecOpenSSLAppDefaultKeysMngrSave
                                                (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.
### xmlSecOpenSSLAppKeysMngrCertLoad ()
    int         xmlSecOpenSSLAppKeysMngrCertLoad
                                                (xmlSecKeysMngrPtr mngr,
                                                 const char *filename,
                                                 xmlSecKeyDataFormat format,
                                                 xmlSecKeyDataType type);
Reads cert from `filename` and adds to the list of trusted or known untrusted certs in `store`.
`mngr` : | the keys manager.
`filename` : | the certificate file.
`format` : | the certificate file format.
`type` : | the flag that indicates is the certificate in `filename` trusted or not.
Returns : | 0 on success or a negative value otherwise.
### xmlSecOpenSSLAppKeysMngrAddCertsPath ()
    int         xmlSecOpenSSLAppKeysMngrAddCertsPath
                                                (xmlSecKeysMngrPtr mngr,
                                                 const char *path);
Reads cert from `path` and adds to the list of trusted certificates.
`mngr` : | the keys manager.
`path` : | the path to trusted certificates.
Returns : | 0 on success or a negative value otherwise.
### xmlSecOpenSSLAppKeyLoad ()
    xmlSecKeyPtr xmlSecOpenSSLAppKeyLoad        (const char *filename,
                                                 xmlSecKeyDataFormat format,
                                                 const char *pwd,
                                                 pem_password_cb *pwdCallback,
                                                 void *pwdCallbackCtx);
Reads key from the a file.
`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.
### xmlSecOpenSSLAppPkcs12Load ()
    xmlSecKeyPtr xmlSecOpenSSLAppPkcs12Load     (const char *filename,
                                                 const char *pwd,
                                                 pem_password_cb *pwdCallback,
                                                 void *pwdCallbackCtx);
Reads key and all associated certificates from the PKCS12 file.
`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.
### xmlSecOpenSSLAppKeyCertLoad ()
    int         xmlSecOpenSSLAppKeyCertLoad     (xmlSecKeyPtr key,
                                                 const char *filename,
                                                 xmlSecKeyDataFormat format);
Reads the certificate from $`filename` and adds it to key.
`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 OpenSLL API Reference. | bn
Aleksey Sanin