Sailfish Crypto

API Documentation

Key QML Type

An instance of a key which can be used for cryptographic operations. More...

Import Statement:	import Sailfish.Crypto 1.0
Instantiates:	Key

List of all members, including inherited members

Properties

algorithm : enumeration
collectionName : string
componentConstraints : flags
customParameters : Array
filterDataFields : Array
name : string
operations : flags
origin : enumeration
privateKey : ArrayBuffer
publicKey : ArrayBuffer
secretKey : ArrayBuffer
size : int
storagePluginName : string

Methods

string filterData(string field)
bool hasFilterData(string field)
void setFilterData(string field, string value)

Detailed Description

Property Documentation

algorithm : enumeration

the cryptosystem algorithm this key is intended to be used with

Constant	Description
`AlgorithmUnknown`
`AlgorithmCustom`
`AlgorithmRsa`
`AlgorithmDsa`
`AlgorithmDh`
`AlgorithmEc`
`AlgorithmEcDsa`
`AlgorithmEdDsa`
`AlgorithmEcDh`
`AlgorithmEcMqv`
`AlgorithmAes`
`AlgorithmGost`
`AlgorithmTdea`
`AlgorithmTdes`	= AlgorithmTdea
`AlgorithmBlowfish`
`AlgorithmSalsa`
`AlgorithmSalsa20`	= AlgorithmSalsa
`AlgorithmChaCha`
`AlgorithmChaCha20`	= AlgorithmChaCh
`AlgorithmRc4`
`AlgorithmRc5`
`AlgorithmRc6`
`AlgorithmSquare`
`AlgorithmSerpent`
`AlgorithmPanama`

collectionName : string

The collection name field from the identifier of the key

componentConstraints : flags

The types of key components which the client is allowed to retrieve after the key has been stored

Constant	Description
`NoData`
`MetaData`
`PublicKeyData`
`PrivateKeyData`
`SecretKeyData`	= PrivateKeyData

customParameters : Array

The custom parameters associated with this key

filterDataFields : Array

Returns the fields (keys) of filter data associated with the secret

name : string

The name field from the identifier of the key

operations : flags

The set of operations which are supported for this key

Constant	Value
`OperationUnknown`
`OperationCustom`
`OperationSign`
`OperationVerify`
`OperationEncrypt`
`OperationDecrypt`
`OperationCalculateDigest`
`OperationCalculateMac`
`OperationDeriveKey`

origin : enumeration

Ynformation about the origin of the key

Constant	Value
`OriginUnknown`
`OriginImported`
`OriginDevice`
`OriginSecureDevice`

privateKey : ArrayBuffer

The private key data associated with this key (asymmetric cryptosystems only)

publicKey : ArrayBuffer

The public key data associated with this key (asymmetric cryptosystems only)

secretKey : ArrayBuffer

The private key data associated with this key (symmetric cryptosystems only)

size : int

The security size, in bits, of the key.

storagePluginName : string

The storage plugin name field from the identifier of the key

Method Documentation

string filterData(string field)

Returns the filter data value for the given field.

bool hasFilterData(string field)

Returns true if the key has a filter data value specified for the given field.

void setFilterData(string field, string value)

Sets filter data for the given field to the given value.