- Home
- Download
- News
- Documentation

- FAQ
- Tutorial
- API reference
- Examples

- XML Digital Signature

- Online Verifier

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

# keysstore

## Name

keysstore -- Keys store implementation for MS Crypto.

## Synopsis

    intxmlSecMSCryptoKeysStoreAdoptKey     (xmlSecKeyStorePtr store,
                                                             xmlSecKeyPtr key);
    xmlSecKeyStoreIdxmlSecMSCryptoKeysStoreGetKlass     (void);
    #define             xmlSecMSCryptoKeysStoreId
    intxmlSecMSCryptoKeysStoreLoad         (xmlSecKeyStorePtr store,
                                                             const char *uri,
                                                             xmlSecKeysMngrPtr keysMngr);
    intxmlSecMSCryptoKeysStoreSave         (xmlSecKeyStorePtr store,
                                                             const char *filename,
                                                             xmlSecKeyDataType type);

## Description

Keys store implementation for MS Crypto.

## Details

### xmlSecMSCryptoKeysStoreAdoptKey ()

    int                 xmlSecMSCryptoKeysStoreAdoptKey     (xmlSecKeyStorePtr store,
                                                             xmlSecKeyPtr key);

Adds `key` to the `store`.

`store` : | the pointer to MSCrypto keys store.
`key` : | the pointer to key.
Returns : | 0 on success or a negative value if an error occurs.

### xmlSecMSCryptoKeysStoreGetKlass ()

    xmlSecKeyStoreId    xmlSecMSCryptoKeysStoreGetKlass     (void);

The MSCrypto list based keys store klass.

Returns : | MSCrypto list based keys store klass.

### xmlSecMSCryptoKeysStoreId

    #define xmlSecMSCryptoKeysStoreId       xmlSecMSCryptoKeysStoreGetKlass()

A MSCrypto keys store klass id.

### xmlSecMSCryptoKeysStoreLoad ()

    int                 xmlSecMSCryptoKeysStoreLoad         (xmlSecKeyStorePtr store,
                                                             const char *uri,
                                                             xmlSecKeysMngrPtr keysMngr);

Reads keys from an XML file.

`store` : | the pointer to MSCrypto keys store.
`uri` : | the filename.
`keysMngr` : | the pointer to associated keys manager.
Returns : | 0 on success or a negative value if an error occurs.

### xmlSecMSCryptoKeysStoreSave ()

    int                 xmlSecMSCryptoKeysStoreSave         (xmlSecKeyStorePtr store,
                                                             const char *filename,
                                                             xmlSecKeyDataType type);

Writes keys from `store` to an XML file.

`store` : | the pointer to MSCrypto keys store.
`filename` : | the filename.
`type` : | the saved keys type (public, private, ...).
Returns : | 0 on success or a negative value if an error occurs.