Module "core/signing/goalSigning"

Index

Classes

GoalSigningAutomationEventListener

Interfaces

SignatureMixin

Variables

DefaultGoalSigningAlgorithm

Functions

Variables

Const DefaultGoalSigningAlgorithm

DefaultGoalSigningAlgorithm: GoalSigningAlgorithm<string> = RsaGoalSigningAlgorithm

Functions

findAlgorithm

findAlgorithm(key: GoalVerificationKey<any> | GoalSigningKey<any>, gsc: GoalSigningConfiguration): GoalSigningAlgorithm<any>

- Defined in lib/core/signing/goalSigning.ts:154
Parameters
- key: GoalVerificationKey<any> | GoalSigningKey<any>
- gsc: GoalSigningConfiguration
Returns GoalSigningAlgorithm<any>

isGoalRejected

isGoalRejected(sdmGoal: SdmGoalEvent): boolean

- Defined in lib/core/signing/goalSigning.ts:176
Parameters
- sdmGoal: SdmGoalEvent
Returns boolean

isInScope

isInScope(scope: GoalSigningScope, ctx: HandlerContext): boolean

- Defined in lib/core/signing/goalSigning.ts:165
Parameters
- scope: GoalSigningScope
- ctx: HandlerContext
Returns boolean

normalizeGoal

normalizeGoal(goal: SdmGoalMessage | SdmGoalEvent): string

- Defined in lib/core/signing/goalSigning.ts:180
Parameters
- goal: SdmGoalMessage | SdmGoalEvent
Returns string

normalizeValue

normalizeValue(value: any): any

- Defined in lib/core/signing/goalSigning.ts:266
Parameters
- value: any
Returns any

rejectGoal

rejectGoal(reason: string, sdmGoal: SdmGoalEvent, ctx: HandlerContext): Promise<void>

- Defined in lib/core/signing/goalSigning.ts:141
Parameters
- reason: string
- sdmGoal: SdmGoalEvent
- ctx: HandlerContext
Returns Promise<void>

signGoal

signGoal(goal: SdmGoalMessage, gsc: GoalSigningConfiguration): SdmGoalMessage & SignatureMixin

- Defined in lib/core/signing/goalSigning.ts:130
Add a signature to a goal

Parameters
- goal: SdmGoalMessage
- gsc: GoalSigningConfiguration
Returns SdmGoalMessage & SignatureMixin

verifyGoal

verifyGoal(goal: SdmGoalEvent & DeepPartial<SignatureMixin>, gsc: GoalSigningConfiguration, ctx: HandlerContext): Promise<void>

- Defined in lib/core/signing/goalSigning.ts:93
Verify a goal signature against the public keys configured in provided Configuration. If signature can't be verified, the goal will be marked as failed and an Error will be thrown.

Parameters
- goal: SdmGoalEvent & DeepPartial<SignatureMixin>
  
  goal to verify
- gsc: GoalSigningConfiguration
  
  signing configuration
- ctx: HandlerContext
Returns Promise<void>

Generated using TypeDoc