Skip to content

CryptoKey

[<Interface>]
type CryptoKey =
    abstract member algorithm: KeyAlgorithm
    abstract member extractable: bool
    abstract member type: KeyType
    abstract member usages: KeyUsage array
    static member Create (algorithm: KeyAlgorithm, extractable: bool, type: KeyType, usages: KeyUsage array) : CryptoKey
AssemblyXantham.Fable.Node
Attributes[<Interface>]

@since v15.0.0

Properties

abstract member algorithm: KeyAlgorithm

An object detailing the algorithm for which the key can be used along with additional algorithm-specific parameters.

@since v15.0.0

abstract member extractable: bool

When true, the CryptoKey can be extracted using either subtleCrypto.exportKey() or subtleCrypto.wrapKey().

@since v15.0.0

abstract member type: KeyType

A string identifying whether the key is a symmetric ('secret') or asymmetric ('private' or 'public') key.

@since v15.0.0

abstract member usages: KeyUsage array

An array of strings identifying the operations for which the key may be used.

The possible usages are:

  • 'encrypt' - The key may be used to encrypt data.
  • 'decrypt' - The key may be used to decrypt data.
  • 'sign' - The key may be used to generate digital signatures.
  • 'verify' - The key may be used to verify digital signatures.
  • 'deriveKey' - The key may be used to derive a new key.
  • 'deriveBits' - The key may be used to derive bits.
  • 'wrapKey' - The key may be used to wrap another key.
  • 'unwrapKey' - The key may be used to unwrap another key.

Valid key usages depend on the key algorithm (identified by cryptokey.algorithm.name).

@since v15.0.0

Methods

static member Create (algorithm: KeyAlgorithm, extractable: bool, type: KeyType, usages: KeyUsage array) : CryptoKey