Skip to main content

Function: assertPurposePermitted()

assertPurposePermitted(environment, kind, purpose, started, policy?): void

Defined in: packages/key-custodian/src/policy.ts:228

The per-call check, at generate and generateWrappingKey. It repeats the start-up check for the one purpose asked for, so a purpose the custodian was not started for is refused rather than silently allowed.

Parameters​

environment​

"staging" | "development" | "ci" | "integration" | "production"

kind​

TokenKind

purpose​

KeyPurpose

started​

readonly KeyPurpose[]

policy?​

KeyPolicy = KEY_POLICY

Returns​

void

Throws​

policy_refused.