plugin

Overview ¶

Package plugin defines lifecycle hook interfaces for Keysmith plugins.

Plugins extend Keysmith by implementing opt-in lifecycle hook interfaces. A plugin must implement the base Plugin interface (which requires only a Name), and may additionally implement any combination of the hook interfaces below.

Available key lifecycle hooks:

• KeyCreated — fired after a key is successfully created
• KeyCreateFailed — fired when key creation fails
• KeyValidated — fired after a key passes validation
• KeyValidationFailed: fired when key validation fails (not on a store outage)
• KeyRotated — fired after a key is rotated
• KeyRevoked — fired when a key is permanently revoked
• KeySuspended — fired when a key is temporarily suspended
• KeyReactivated — fired when a suspended key is reactivated
• KeyExpired — fired when a key is found expired during validation
• KeyRateLimited — fired when a key exceeds its rate limit

Available policy lifecycle hooks:

• PolicyCreated — fired after a policy is created
• PolicyUpdated — fired after a policy is updated
• PolicyDeleted — fired after a policy is deleted

Shutdown hook:

• Shutdown — fired during graceful engine shutdown

Example plugin:

type myPlugin struct{}

func (p *myPlugin) Name() string { return "my-plugin" }

func (p *myPlugin) OnKeyCreated(ctx context.Context, k *key.Key) error {
    log.Println("key created:", k.ID)
    return nil
}