Oihana PHP Enums

JwkKeyOperation uses ConstantsTrait

Enumeration of JSON Web Key operations (entries of the `key_ops` member of a JWK).

The key_ops parameter is a JSON array listing the operations the key is intended to be used for (RFC 7517 §4.3). It conveys finer-grained intent than JwkUse (use); the two should not be set inconsistently.

Example:

$jwk[ JwkParameter::KEY_OPS ] = [ JwkKeyOperation::SIGN , JwkKeyOperation::VERIFY ] ;

References:

  • RFC 7517 §4.3 — key_ops values
  • IANA JSON Web Key Operations registry
Tags
see
JwkParameter::KEY_OPS
JwkUse
author

Marc Alcaraz (ekameleon)

since
1.1.0

Table of Contents

Constants

DECRYPT  : string = 'decrypt'
`decrypt` — Decrypt content and validate decryption, if applicable (RFC 7517 §4.3).
DERIVE_BITS  : string = 'deriveBits'
`deriveBits` — Derive bits not to be used as a key (RFC 7517 §4.3).
DERIVE_KEY  : string = 'deriveKey'
`deriveKey` — Derive a key (RFC 7517 §4.3).
ENCRYPT  : string = 'encrypt'
`encrypt` — Encrypt content (RFC 7517 §4.3).
SIGN  : string = 'sign'
`sign` — Compute a digital signature or MAC (RFC 7517 §4.3).
UNWRAP_KEY  : string = 'unwrapKey'
`unwrapKey` — Decrypt a key and validate decryption, if applicable (RFC 7517 §4.3).
VERIFY  : string = 'verify'
`verify` — Verify a digital signature or MAC (RFC 7517 §4.3).
WRAP_KEY  : string = 'wrapKey'
`wrapKey` — Encrypt a key (RFC 7517 §4.3).

Constants

DECRYPT

`decrypt` — Decrypt content and validate decryption, if applicable (RFC 7517 §4.3).

public string DECRYPT = 'decrypt'

DERIVE_BITS

`deriveBits` — Derive bits not to be used as a key (RFC 7517 §4.3).

public string DERIVE_BITS = 'deriveBits'

DERIVE_KEY

`deriveKey` — Derive a key (RFC 7517 §4.3).

public string DERIVE_KEY = 'deriveKey'

ENCRYPT

`encrypt` — Encrypt content (RFC 7517 §4.3).

public string ENCRYPT = 'encrypt'

SIGN

`sign` — Compute a digital signature or MAC (RFC 7517 §4.3).

public string SIGN = 'sign'

UNWRAP_KEY

`unwrapKey` — Decrypt a key and validate decryption, if applicable (RFC 7517 §4.3).

public string UNWRAP_KEY = 'unwrapKey'

VERIFY

`verify` — Verify a digital signature or MAC (RFC 7517 §4.3).

public string VERIFY = 'verify'

WRAP_KEY

`wrapKey` — Encrypt a key (RFC 7517 §4.3).

public string WRAP_KEY = 'wrapKey'
On this page

Search results