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

# crypto

## Name

crypto --

## Synopsis

    xmlSecCryptoDLFunctionsPtr xmlSecCryptoGetFunctions_nss
                                                (void);
    int         xmlSecNssInit                   (void);
    int         xmlSecNssShutdown               (void);
    int         xmlSecNssKeysMngrInit           (xmlSecKeysMngrPtr mngr);
    int         xmlSecNssGenerateRandom         (xmlSecBufferPtr buffer,
                                                 xmlSecSize size);
    void        xmlSecNssErrorsDefaultCallback  (const char *file,
                                                 int line,
                                                 const char *func,
                                                 const char *errorObject,
                                                 const char *errorSubject,
                                                 int reason,
                                                 const char *msg);
    #define     xmlSecNssKeyDataAesId
    xmlSecKeyDataId xmlSecNssKeyDataAesGetKlass (void);
    int         xmlSecNssKeyDataAesSet          (xmlSecKeyDataPtr data,
                                                 const xmlSecByte *buf,
                                                 xmlSecSize bufSize);
    #define     xmlSecNssTransformAes128CbcId
    xmlSecTransformId xmlSecNssTransformAes128CbcGetKlass
                                                (void);
    #define     xmlSecNssTransformAes192CbcId
    xmlSecTransformId xmlSecNssTransformAes192CbcGetKlass
                                                (void);
    #define     xmlSecNssTransformAes256CbcId
    xmlSecTransformId xmlSecNssTransformAes256CbcGetKlass
                                                (void);
    #define     xmlSecNssTransformKWAes128Id
    xmlSecTransformId xmlSecNssTransformKWAes128GetKlass
                                                (void);
    #define     xmlSecNssTransformKWAes192Id
    xmlSecTransformId xmlSecNssTransformKWAes192GetKlass
                                                (void);
    #define     xmlSecNssTransformKWAes256Id
    xmlSecTransformId xmlSecNssTransformKWAes256GetKlass
                                                (void);
    #define     xmlSecNssKeyDataDesId
    xmlSecKeyDataId xmlSecNssKeyDataDesGetKlass (void);
    int         xmlSecNssKeyDataDesSet          (xmlSecKeyDataPtr data,
                                                 const xmlSecByte *buf,
                                                 xmlSecSize bufSize);
    #define     xmlSecNssTransformDes3CbcId
    xmlSecTransformId xmlSecNssTransformDes3CbcGetKlass
                                                (void);
    #define     xmlSecNssTransformKWDes3Id
    xmlSecTransformId xmlSecNssTransformKWDes3GetKlass
                                                (void);
    #define     xmlSecNssKeyDataDsaId
    xmlSecKeyDataId xmlSecNssKeyDataDsaGetKlass (void);
    #define     xmlSecNssTransformDsaSha1Id
    xmlSecTransformId xmlSecNssTransformDsaSha1GetKlass
                                                (void);
    #define     xmlSecNssKeyDataHmacId
    xmlSecKeyDataId xmlSecNssKeyDataHmacGetKlass
                                                (void);
    int         xmlSecNssKeyDataHmacSet         (xmlSecKeyDataPtr data,
                                                 const xmlSecByte *buf,
                                                 xmlSecSize bufSize);
    #define     xmlSecNssTransformHmacSha1Id
    xmlSecTransformId xmlSecNssTransformHmacSha1GetKlass
                                                (void);
    #define     xmlSecNssTransformHmacRipemd160Id
    xmlSecTransformId xmlSecNssTransformHmacRipemd160GetKlass
                                                (void);
    #define     xmlSecNssTransformHmacMd5Id
    xmlSecTransformId xmlSecNssTransformHmacMd5GetKlass
                                                (void);
    #define     xmlSecNssKeyDataRsaId
    xmlSecKeyDataId xmlSecNssKeyDataRsaGetKlass (void);
    #define     xmlSecNssTransformRsaSha1Id
    xmlSecTransformId xmlSecNssTransformRsaSha1GetKlass
                                                (void);
    #define     xmlSecNssTransformRsaPkcs1Id
    xmlSecTransformId xmlSecNssTransformRsaPkcs1GetKlass
                                                (void);
    #define     xmlSecNssTransformSha1Id
    xmlSecTransformId xmlSecNssTransformSha1GetKlass
                                                (void);

## Description

## Details

### xmlSecCryptoGetFunctions_nss ()

    xmlSecCryptoDLFunctionsPtr xmlSecCryptoGetFunctions_nss
                                                (void);

Gets the pointer to xmlsec-nss functions table.

Returns : | the xmlsec-nss functions table or NULL if an error occurs.

### xmlSecNssInit ()

    int         xmlSecNssInit                   (void);

XMLSec library specific crypto engine initialization.

Returns : | 0 on success or a negative value otherwise.

### xmlSecNssShutdown ()

    int         xmlSecNssShutdown               (void);

XMLSec library specific crypto engine shutdown.

Returns : | 0 on success or a negative value otherwise.

### xmlSecNssKeysMngrInit ()

    int         xmlSecNssKeysMngrInit           (xmlSecKeysMngrPtr mngr);

Adds NSS specific key data stores in keys manager.

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

### xmlSecNssGenerateRandom ()

    int         xmlSecNssGenerateRandom         (xmlSecBufferPtr buffer,
                                                 xmlSecSize size);

Generates `size` random bytes and puts result in `buffer`.

`buffer` : | the destination buffer.
`size` : | the numer of bytes to generate.
Returns : | 0 on success or a negative value otherwise.

### xmlSecNssErrorsDefaultCallback ()

    void        xmlSecNssErrorsDefaultCallback  (const char *file,
                                                 int line,
                                                 const char *func,
                                                 const char *errorObject,
                                                 const char *errorSubject,
                                                 int reason,
                                                 const char *msg);

The default errors reporting callback function.

`file` : | the error location file name (__FILE__ macro).
`line` : | the error location line number (__LINE__ macro).
`func` : | the error location function name (__FUNCTION__ macro).
`errorObject` : | the error specific error object
`errorSubject` : | the error specific error subject.
`reason` : | the error code.
`msg` : | the additional error message.

### xmlSecNssKeyDataAesId

    #define     xmlSecNssKeyDataAesId

The AES key data klass.

### xmlSecNssKeyDataAesGetKlass ()

    xmlSecKeyDataId xmlSecNssKeyDataAesGetKlass (void);

The AES key data klass.

Returns : | AES key data klass.

### xmlSecNssKeyDataAesSet ()

    int         xmlSecNssKeyDataAesSet          (xmlSecKeyDataPtr data,
                                                 const xmlSecByte *buf,
                                                 xmlSecSize bufSize);

Sets the value of AES key data.

`data` : | the pointer to AES key data.
`buf` : | the pointer to key value.
`bufSize` : | the key value size (in bytes).
Returns : | 0 on success or a negative value if an error occurs.

### xmlSecNssTransformAes128CbcId

    #define     xmlSecNssTransformAes128CbcId

The AES128 CBC cipher transform klass.

### xmlSecNssTransformAes128CbcGetKlass ()

    xmlSecTransformId xmlSecNssTransformAes128CbcGetKlass
                                                (void);

AES 128 CBC encryption transform klass.

Returns : | pointer to AES 128 CBC encryption transform.

### xmlSecNssTransformAes192CbcId

    #define     xmlSecNssTransformAes192CbcId

The AES192 CBC cipher transform klass.

### xmlSecNssTransformAes192CbcGetKlass ()

    xmlSecTransformId xmlSecNssTransformAes192CbcGetKlass
                                                (void);

AES 192 CBC encryption transform klass.

Returns : | pointer to AES 192 CBC encryption transform.

### xmlSecNssTransformAes256CbcId

    #define     xmlSecNssTransformAes256CbcId

The AES256 CBC cipher transform klass.

### xmlSecNssTransformAes256CbcGetKlass ()

    xmlSecTransformId xmlSecNssTransformAes256CbcGetKlass
                                                (void);

AES 256 CBC encryption transform klass.

Returns : | pointer to AES 256 CBC encryption transform.

### xmlSecNssTransformKWAes128Id

    #define     xmlSecNssTransformKWAes128Id

The AES 128 key wrap transform klass.

### xmlSecNssTransformKWAes128GetKlass ()

    xmlSecTransformId xmlSecNssTransformKWAes128GetKlass
                                                (void);

The AES-128 key wrapper transform klass.

Returns : | AES-128 key wrapper transform klass.

### xmlSecNssTransformKWAes192Id

    #define     xmlSecNssTransformKWAes192Id

The AES 192 key wrap transform klass.

### xmlSecNssTransformKWAes192GetKlass ()

    xmlSecTransformId xmlSecNssTransformKWAes192GetKlass
                                                (void);

The AES-192 key wrapper transform klass.

Returns : | AES-192 key wrapper transform klass.

### xmlSecNssTransformKWAes256Id

    #define     xmlSecNssTransformKWAes256Id

The AES 256 key wrap transform klass.

### xmlSecNssTransformKWAes256GetKlass ()

    xmlSecTransformId xmlSecNssTransformKWAes256GetKlass
                                                (void);

The AES-256 key wrapper transform klass.

Returns : | AES-256 key wrapper transform klass.

### xmlSecNssKeyDataDesId

    #define     xmlSecNssKeyDataDesId

The DES key data klass.

### xmlSecNssKeyDataDesGetKlass ()

    xmlSecKeyDataId xmlSecNssKeyDataDesGetKlass (void);

The DES key data klass.

Returns : | DES key data klass.

### xmlSecNssKeyDataDesSet ()

    int         xmlSecNssKeyDataDesSet          (xmlSecKeyDataPtr data,
                                                 const xmlSecByte *buf,
                                                 xmlSecSize bufSize);

Sets the value of DES key data.

`data` : | the pointer to DES key data.
`buf` : | the pointer to key value.
`bufSize` : | the key value size (in bytes).
Returns : | 0 on success or a negative value if an error occurs.

### xmlSecNssTransformDes3CbcId

    #define     xmlSecNssTransformDes3CbcId

The Triple DES CBC cipher transform klass.

### xmlSecNssTransformDes3CbcGetKlass ()

    xmlSecTransformId xmlSecNssTransformDes3CbcGetKlass
                                                (void);

Triple DES CBC encryption transform klass.

Returns : | pointer to Triple DES encryption transform.

### xmlSecNssTransformKWDes3Id

    #define     xmlSecNssTransformKWDes3Id

The DES3 CBC cipher transform klass.

### xmlSecNssTransformKWDes3GetKlass ()

    xmlSecTransformId xmlSecNssTransformKWDes3GetKlass
                                                (void);

The Triple DES key wrapper transform klass.

Returns : | Triple DES key wrapper transform klass.

### xmlSecNssKeyDataDsaId

    #define     xmlSecNssKeyDataDsaId

The DSA key klass.

### xmlSecNssKeyDataDsaGetKlass ()

    xmlSecKeyDataId xmlSecNssKeyDataDsaGetKlass (void);

The DSA key data klass.

Returns : | pointer to DSA key data klass.

### xmlSecNssTransformDsaSha1Id

    #define     xmlSecNssTransformDsaSha1Id

The DSA SHA1 signature transform klass.

### xmlSecNssTransformDsaSha1GetKlass ()

    xmlSecTransformId xmlSecNssTransformDsaSha1GetKlass
                                                (void);

The DSA-SHA1 signature transform klass.

Returns : | DSA-SHA1 signature transform klass.

### xmlSecNssKeyDataHmacId

    #define     xmlSecNssKeyDataHmacId

The DHMAC key data klass.

### xmlSecNssKeyDataHmacGetKlass ()

    xmlSecKeyDataId xmlSecNssKeyDataHmacGetKlass
                                                (void);

The HMAC key data klass.

Returns : | HMAC key data klass.

### xmlSecNssKeyDataHmacSet ()

    int         xmlSecNssKeyDataHmacSet         (xmlSecKeyDataPtr data,
                                                 const xmlSecByte *buf,
                                                 xmlSecSize bufSize);

Sets the value of HMAC key data.

`data` : | the pointer to HMAC key data.
`buf` : | the pointer to key value.
`bufSize` : | the key value size (in bytes).
Returns : | 0 on success or a negative value if an error occurs.

### xmlSecNssTransformHmacSha1Id

    #define     xmlSecNssTransformHmacSha1Id

The HMAC with SHA1 signature transform klass.

### xmlSecNssTransformHmacSha1GetKlass ()

    xmlSecTransformId xmlSecNssTransformHmacSha1GetKlass
                                                (void);

The HMAC-SHA1 transform klass.

Returns : | the HMAC-SHA1 transform klass.

### xmlSecNssTransformHmacRipemd160Id

    #define     xmlSecNssTransformHmacRipemd160Id

The HMAC with RipeMD160 signature transform klass.

### xmlSecNssTransformHmacRipemd160GetKlass ()

    xmlSecTransformId xmlSecNssTransformHmacRipemd160GetKlass
                                                (void);

The HMAC-RIPEMD160 transform klass.

Returns : | the HMAC-RIPEMD160 transform klass.

### xmlSecNssTransformHmacMd5Id

    #define     xmlSecNssTransformHmacMd5Id

The HMAC with MD5 signature transform klass.

### xmlSecNssTransformHmacMd5GetKlass ()

    xmlSecTransformId xmlSecNssTransformHmacMd5GetKlass
                                                (void);

The HMAC-MD5 transform klass.

Returns : | the HMAC-MD5 transform klass.

### xmlSecNssKeyDataRsaId

    #define     xmlSecNssKeyDataRsaId

The RSA key klass.

### xmlSecNssKeyDataRsaGetKlass ()

    xmlSecKeyDataId xmlSecNssKeyDataRsaGetKlass (void);

The RSA key data klass.

Returns : | pointer to RSA key data klass.

### xmlSecNssTransformRsaSha1Id

    #define     xmlSecNssTransformRsaSha1Id

The RSA-SHA1 signature transform klass.

### xmlSecNssTransformRsaSha1GetKlass ()

    xmlSecTransformId xmlSecNssTransformRsaSha1GetKlass
                                                (void);

The RSA-SHA1 signature transform klass.

Returns : | RSA-SHA1 signature transform klass.

### xmlSecNssTransformRsaPkcs1Id

    #define     xmlSecNssTransformRsaPkcs1Id

The RSA PKCS1 key transport transform klass.

### xmlSecNssTransformRsaPkcs1GetKlass ()

    xmlSecTransformId xmlSecNssTransformRsaPkcs1GetKlass
                                                (void);

The RSA-PKCS1 key transport transform klass.

Returns : | RSA-PKCS1 key transport transform klass.

### xmlSecNssTransformSha1Id

    #define     xmlSecNssTransformSha1Id

The SHA1 digest transform klass.

### xmlSecNssTransformSha1GetKlass ()

    xmlSecTransformId xmlSecNssTransformSha1GetKlass
                                                (void);

SHA-1 digest transform klass.

Returns : | pointer to SHA-1 digest transform klass.

<<< Previous Page | Home | Up | Next Page >>>
bignum | keysstore

Aleksey Sanin