Skip to main content

Class: SigningKeySQL

Defined in: auth/src/models/sql/SigningKeySQL.ts:39

Implementation of the SigningKey interface for storage in a SQL database. If MongoDB is desired, please use models.mongo.SigningKeyMongo instead.

Extends​

  • BaseEntity

Implements​

Constructors​

Constructor​

new SigningKeySQL(other?): SigningKeySQL

Defined in: auth/src/models/sql/SigningKeySQL.ts:65

Parameters​

other?​

Partial<SigningKeySQL>

Returns​

SigningKeySQL

Overrides​

BaseEntity.constructor

Properties​

activatedAt​

activatedAt: Date

Defined in: auth/src/models/sql/SigningKeySQL.ts:59

The date this key became ACTIVE.

Implementation of​

SigningKey.activatedAt

alg​

alg: "RS256" = "RS256"

Defined in: auth/src/models/sql/SigningKeySQL.ts:46

The signing algorithm this key is used with.

Implementation of​

SigningKey.alg

dateCreated​

dateCreated: Date

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:18

The date and time that the entity was created.

Implementation of​

SigningKey.dateCreated

Inherited from​

BaseEntity.dateCreated

dateModified​

dateModified: Date

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:22

The date and time that the entity was last modified.

Implementation of​

SigningKey.dateModified

Inherited from​

BaseEntity.dateModified

kid​

kid: string = ""

Defined in: auth/src/models/sql/SigningKeySQL.ts:43

The key id, embedded in every token's kid header so a verifier can select the matching public key.

Implementation of​

SigningKey.kid

privateKeyEncrypted​

privateKeyEncrypted: string = ""

Defined in: auth/src/models/sql/SigningKeySQL.ts:52

The private half of the key pair, PEM-encoded and encrypted at rest (see SigningKeyUtils).

Implementation of​

SigningKey.privateKeyEncrypted

publicKeyJwk​

publicKeyJwk: any = {}

Defined in: auth/src/models/sql/SigningKeySQL.ts:49

The public half of the key pair, as a JWK — safe to serve directly from /jwks.json.

Implementation of​

SigningKey.publicKeyJwk

retiredAt?​

optional retiredAt?: Date

Defined in: auth/src/models/sql/SigningKeySQL.ts:63

The date this key was retired, if it has been.

Implementation of​

SigningKey.retiredAt

status​

status: SigningKeyStatus = SigningKeyStatus.ACTIVE

Defined in: auth/src/models/sql/SigningKeySQL.ts:56

Whether this key is currently used to sign new tokens, or only retained to verify old ones.

Implementation of​

SigningKey.status

uid​

uid: string

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:14

The universally unique identifier of the entity.

Implementation of​

SigningKey.uid

Inherited from​

BaseEntity.uid

version​

version: number

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:26

The optimistic lock version.

Implementation of​

SigningKey.version

Inherited from​

BaseEntity.version