- Home
- Download
- News
- Documentation

- FAQ
- Tutorial
- API reference
- Examples

- XML Digital Signature

- Online Verifier

- XML Encryption
- XML Canonicalization
- Reporting Bugs
- Mailing list
- Related
- Authors

XML Security Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# app

## Name

app --

## Synopsis

    int         xmlSecGnuTLSAppInit             (const char *config);
    int         xmlSecGnuTLSAppShutdown         (void);
    int         xmlSecGnuTLSAppDefaultKeysMngrInit
                                                (xmlSecKeysMngrPtr mngr);
    int         xmlSecGnuTLSAppDefaultKeysMngrAdoptKey
                                                (xmlSecKeysMngrPtr mngr,
                                                 xmlSecKeyPtr key);
    int         xmlSecGnuTLSAppDefaultKeysMngrLoad
                                                (xmlSecKeysMngrPtr mngr,
                                                 const char *uri);
    int         xmlSecGnuTLSAppDefaultKeysMngrSave
                                                (xmlSecKeysMngrPtr mngr,
                                                 const char *filename,
                                                 xmlSecKeyDataType type);
    int         xmlSecGnuTLSAppKeysMngrCertLoad (xmlSecKeysMngrPtr mngr,
                                                 const char *filename,
                                                 xmlSecKeyDataFormat format,
                                                 xmlSecKeyDataType type);
    xmlSecKeyPtr xmlSecGnuTLSAppKeyLoad         (const char *filename,
                                                 xmlSecKeyDataFormat format,
                                                 const char *pwd,
                                                 void *pwdCallback,
                                                 void *pwdCallbackCtx);
    xmlSecKeyPtr xmlSecGnuTLSAppPkcs12Load      (const char *filename,
                                                 const char *pwd,
                                                 void *pwdCallback,
                                                 void *pwdCallbackCtx);
    int         xmlSecGnuTLSAppKeyCertLoad      (xmlSecKeyPtr key,
                                                 const char *filename,
                                                 xmlSecKeyDataFormat format);
    void*       xmlSecGnuTLSAppGetDefaultPwdCallback
                                                (void);

## Description

## Details

### xmlSecGnuTLSAppInit ()

    int         xmlSecGnuTLSAppInit             (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 GnuTLS configuration (unused).
Returns : | 0 on success or a negative value otherwise.

### xmlSecGnuTLSAppShutdown ()

    int         xmlSecGnuTLSAppShutdown         (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.

### xmlSecGnuTLSAppDefaultKeysMngrInit ()

    int         xmlSecGnuTLSAppDefaultKeysMngrInit
                                                (xmlSecKeysMngrPtr mngr);

Initializes `mngr` with simple keys store xmlSecSimpleKeysStoreId and a default GnuTLS crypto key data stores.

`mngr` : | the pointer to keys manager.
Returns : | 0 on success or a negative value otherwise.

### xmlSecGnuTLSAppDefaultKeysMngrAdoptKey ()

    int         xmlSecGnuTLSAppDefaultKeysMngrAdoptKey
                                                (xmlSecKeysMngrPtr mngr,
                                                 xmlSecKeyPtr key);

Adds `key` to the keys manager `mngr` created with xmlSecGnuTLSAppDefaultKeysMngrInit function.

`mngr` : | the pointer to keys manager.
`key` : | the pointer to key.
Returns : | 0 on success or a negative value otherwise.

### xmlSecGnuTLSAppDefaultKeysMngrLoad ()

    int         xmlSecGnuTLSAppDefaultKeysMngrLoad
                                                (xmlSecKeysMngrPtr mngr,
                                                 const char *uri);

Loads XML keys file from `uri` to the keys manager `mngr` created with xmlSecGnuTLSAppDefaultKeysMngrInit function.

`mngr` : | the pointer to keys manager.
`uri` : | the uri.
Returns : | 0 on success or a negative value otherwise.

### xmlSecGnuTLSAppDefaultKeysMngrSave ()

    int         xmlSecGnuTLSAppDefaultKeysMngrSave
                                                (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.

### xmlSecGnuTLSAppKeysMngrCertLoad ()

    int         xmlSecGnuTLSAppKeysMngrCertLoad (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` (not implemented yet).

`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.

### xmlSecGnuTLSAppKeyLoad ()

    xmlSecKeyPtr xmlSecGnuTLSAppKeyLoad         (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 key file password.
`pwdCallback` : | the key password callback.
`pwdCallbackCtx` : | the user context for password callback.
Returns : | pointer to the key or NULL if an error occurs.

### xmlSecGnuTLSAppPkcs12Load ()

    xmlSecKeyPtr xmlSecGnuTLSAppPkcs12Load      (const char *filename,
                                                 const char *pwd,
                                                 void *pwdCallback,
                                                 void *pwdCallbackCtx);

Reads key and all associated certificates from the PKCS12 file (not implemented yet). For uniformity, call xmlSecGnuTLSAppKeyLoad instead of this function. Pass in format=xmlSecKeyDataFormatPkcs12.

`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.

### xmlSecGnuTLSAppKeyCertLoad ()

    int         xmlSecGnuTLSAppKeyCertLoad      (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.

### xmlSecGnuTLSAppGetDefaultPwdCallback ()

    void*       xmlSecGnuTLSAppGetDefaultPwdCallback
                                                (void);

Gets default password callback.

<<< Previous Page | Home | Up | Next Page >>>
XML Security Library for GnuTLS API Reference. | crypto

Aleksey Sanin