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 xmlSecOpenSSLAppKeysMngrCertLoadMemory
(xmlSecKeysMngrPtr mngr,
const xmlSecByte *data,
xmlSecSize dataSize,
xmlSecKeyDataFormat format,
xmlSecKeyDataType type);
int xmlSecOpenSSLAppKeysMngrCertLoadBIO (xmlSecKeysMngrPtr mngr,
BIO *bio,
xmlSecKeyDataFormat format,
xmlSecKeyDataType type);
int xmlSecOpenSSLAppKeysMngrAddCertsPath
(xmlSecKeysMngrPtr mngr,
const char *path);
int xmlSecOpenSSLAppKeysMngrAddCertsFile
(xmlSecKeysMngrPtr mngr,
const char *file);
xmlSecKeyPtr xmlSecOpenSSLAppKeyLoad (const char *filename,
xmlSecKeyDataFormat format,
const char *pwd,
void *pwdCallback,
void *pwdCallbackCtx);
xmlSecKeyPtr xmlSecOpenSSLAppKeyLoadMemory (const xmlSecByte *data,
xmlSecSize dataSize,
xmlSecKeyDataFormat format,
const char *pwd,
void *pwdCallback,
void *pwdCallbackCtx);
xmlSecKeyPtr xmlSecOpenSSLAppKeyLoadBIO (BIO *bio,
xmlSecKeyDataFormat format,
const char *pwd,
void *pwdCallback,
void *pwdCallbackCtx);
xmlSecKeyPtr xmlSecOpenSSLAppPkcs12Load (const char *filename,
const char *pwd,
void *pwdCallback,
void *pwdCallbackCtx);
xmlSecKeyPtr xmlSecOpenSSLAppPkcs12LoadMemory (const xmlSecByte *data,
xmlSecSize dataSize,
const char *pwd,
void *pwdCallback,
void *pwdCallbackCtx);
xmlSecKeyPtr xmlSecOpenSSLAppPkcs12LoadBIO (BIO *bio,
const char *pwd,
void *pwdCallback,
void *pwdCallbackCtx);
int xmlSecOpenSSLAppKeyCertLoad (xmlSecKeyPtr key,
const char *filename,
xmlSecKeyDataFormat format);
int xmlSecOpenSSLAppKeyCertLoadMemory (xmlSecKeyPtr key,
const xmlSecByte *data,
xmlSecSize dataSize,
xmlSecKeyDataFormat format);
int xmlSecOpenSSLAppKeyCertLoadBIO (xmlSecKeyPtr key,
BIO *bio,
xmlSecKeyDataFormat format);
xmlSecKeyPtr xmlSecOpenSSLAppKeyFromCertLoadBIO (BIO *bio,
xmlSecKeyDataFormat format);
void* xmlSecOpenSSLAppGetDefaultPwdCallback
(void);
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.
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. |
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. |
xmlSecOpenSSLAppKeysMngrCertLoadBIO ()
int xmlSecOpenSSLAppKeysMngrCertLoadBIO (xmlSecKeysMngrPtr mngr,
BIO *bio,
xmlSecKeyDataFormat format,
xmlSecKeyDataType type);
Reads cert from an OpenSSL BIO object and adds to the list of trusted or known
untrusted certs in store
.
mngr : |
the keys manager. |
bio : |
the certificate BIO. |
format : |
the certificate file format. |
type : |
the flag that indicates is the certificate 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. |
xmlSecOpenSSLAppKeysMngrAddCertsFile ()
int xmlSecOpenSSLAppKeysMngrAddCertsFile
(xmlSecKeysMngrPtr mngr,
const char *file);
Reads certs from file
and adds to the list of trusted certificates.
It is possible for file
to contain multiple certs.
mngr : |
the keys manager. |
file : |
the file containing trusted certificates. |
Returns : |
0 on success or a negative value otherwise. |
xmlSecOpenSSLAppKeyLoad ()
xmlSecKeyPtr xmlSecOpenSSLAppKeyLoad (const char *filename,
xmlSecKeyDataFormat format,
const char *pwd,
void *pwdCallback,
void *pwdCallbackCtx);
Reads key from the a file.
xmlSecOpenSSLAppKeyLoadBIO ()
xmlSecKeyPtr xmlSecOpenSSLAppKeyLoadBIO (BIO *bio,
xmlSecKeyDataFormat format,
const char *pwd,
void *pwdCallback,
void *pwdCallbackCtx);
Reads key from the an OpenSSL BIO object.
xmlSecOpenSSLAppPkcs12Load ()
xmlSecKeyPtr xmlSecOpenSSLAppPkcs12Load (const char *filename,
const char *pwd,
void *pwdCallback,
void *pwdCallbackCtx);
Reads key and all associated certificates from the PKCS12 file.
For uniformity, call xmlSecOpenSSLAppKeyLoad instead of this function. Pass
in format=xmlSecKeyDataFormatPkcs12.
xmlSecOpenSSLAppPkcs12LoadMemory ()
xmlSecKeyPtr xmlSecOpenSSLAppPkcs12LoadMemory (const xmlSecByte *data,
xmlSecSize dataSize,
const char *pwd,
void *pwdCallback,
void *pwdCallbackCtx);
Reads key and all associated certificates from the PKCS12 data in memory buffer.
For uniformity, call xmlSecOpenSSLAppKeyLoad instead of this function. Pass
in format=xmlSecKeyDataFormatPkcs12.
xmlSecOpenSSLAppPkcs12LoadBIO ()
xmlSecKeyPtr xmlSecOpenSSLAppPkcs12LoadBIO (BIO *bio,
const char *pwd,
void *pwdCallback,
void *pwdCallbackCtx);
Reads key and all associated certificates from the PKCS12 data in an OpenSSL BIO object.
For uniformity, call xmlSecOpenSSLAppKeyLoad instead of this function. Pass
in format=xmlSecKeyDataFormatPkcs12.
xmlSecOpenSSLAppKeyCertLoad ()
int xmlSecOpenSSLAppKeyCertLoad (xmlSecKeyPtr key,
const char *filename,
xmlSecKeyDataFormat format);
Reads the certificate from $filename
and adds it to key.
xmlSecOpenSSLAppKeyCertLoadBIO ()
int xmlSecOpenSSLAppKeyCertLoadBIO (xmlSecKeyPtr key,
BIO *bio,
xmlSecKeyDataFormat format);
Reads the certificate from memory buffer and adds it to key.
key : |
the pointer to key. |
bio : |
the certificate bio. |
format : |
the certificate file format. |
Returns : |
0 on success or a negative value otherwise. |
xmlSecOpenSSLAppGetDefaultPwdCallback ()
void* xmlSecOpenSSLAppGetDefaultPwdCallback
(void);
Gets default password callback.