Skip to content

Graphorin API reference v0.4.0


Graphorin API reference / @graphorin/security / / SecretStrength

Interface: SecretStrength

Defined in: packages/security/src/hardening/weak-secret.ts:31

Result of assessSecretStrength.

Properties

PropertyModifierTypeDescriptionDefined in
byteLengthreadonlynumber-packages/security/src/hardening/weak-secret.ts:34
distinctBytesreadonlynumberNumber of distinct byte values.packages/security/src/hardening/weak-secret.ts:40
maxIdenticalRunreadonlynumberLongest run of identical consecutive bytes.packages/security/src/hardening/weak-secret.ts:38
okreadonlybooleanWhether the secret cleared every threshold.packages/security/src/hardening/weak-secret.ts:33
reason?readonlystringHuman-readable reason when ok is false.packages/security/src/hardening/weak-secret.ts:42
shannonBitsPerBytereadonlynumberEstimated Shannon entropy of the byte distribution (bits/byte).packages/security/src/hardening/weak-secret.ts:36