Interface: SweptKey

Defined in: packages/key-custodian/src/pkcs11/sweep.ts:48

One key the sweep found under the prefix, and what became of it.

Properties

code?

readonly optional code?: "unwrap_failed" | "custody_unavailable" | "invalid_handle" | "invalid_request" | "backend_missing" | "unsupported_algorithm" | "policy_refused" | "duplicate_key" | "login_failed"

Defined in: packages/key-custodian/src/pkcs11/sweep.ts:56

Why not, when failed.

---

handle

readonly handle: `hsm:v1:${string}:${string}`

Defined in: packages/key-custodian/src/pkcs11/sweep.ts:52

The key's handle, as generate would have returned it.

---

label

readonly label: string

Defined in: packages/key-custodian/src/pkcs11/sweep.ts:50

The label the key's objects carry.

---

outcome

readonly outcome: "failed" | "destroyed"

Defined in: packages/key-custodian/src/pkcs11/sweep.ts:54

destroyed when every matching object of the key is gone.