integrationkey

Documentation

Index

• Constants
• type InKeySearchOptions
• type IntegrationKey
  • func (i IntegrationKey) Normalize() (*IntegrationKey, error)
• type Store
  • func NewStore(ctx context.Context, db *sql.DB, keys keyring.Keyring, reg *nfydest.Registry, ...) *Store
  • func (s *Store) Authorize(ctx context.Context, tok authtoken.Token, t Type) (context.Context, error)
  • func (s *Store) AuthorizeUIK(ctx context.Context, tokStr string) (context.Context, error)
  • func (s *Store) Config(ctx context.Context, db gadb.DBTX, keyID uuid.UUID) (*gadb.UIKConfigV1, error)
  • func (s *Store) Create(ctx context.Context, dbtx gadb.DBTX, i *IntegrationKey) (*IntegrationKey, error)
  • func (s *Store) Delete(ctx context.Context, dbtx gadb.DBTX, id string) error
  • func (s *Store) DeleteMany(ctx context.Context, dbtx gadb.DBTX, ids []string) error
  • func (s *Store) DeleteSecondaryToken(ctx context.Context, db gadb.DBTX, id uuid.UUID) error
  • func (s *Store) FindAllByService(ctx context.Context, serviceID string) ([]IntegrationKey, error)
  • func (s *Store) FindOne(ctx context.Context, id string) (*IntegrationKey, error)
  • func (s *Store) GenerateToken(ctx context.Context, db gadb.DBTX, id uuid.UUID) (string, error)
  • func (s *Store) GetServiceID(ctx context.Context, id string, t Type) (string, error)
  • func (s *Store) PromoteSecondaryToken(ctx context.Context, db gadb.DBTX, id uuid.UUID) error
  • func (s *Store) Search(ctx context.Context, opts *InKeySearchOptions) ([]IntegrationKey, error)
  • func (s *Store) SetConfig(ctx context.Context, db gadb.DBTX, keyID uuid.UUID, cfg *gadb.UIKConfigV1) error
  • func (s *Store) TokenHints(ctx context.Context, db gadb.DBTX, id uuid.UUID) (primary, secondary string, err error)
  • func (s *Store) ValidateUIKConfigV1(ctx context.Context, cfg gadb.UIKConfigV1) error
• type Type
  • func (s *Type) Scan(value interface{}) error
  • func (s Type) Value() (driver.Value, error)

Constants

const (
	MaxRules   = 100
	MaxActions = 10
	MaxParams  = 10
)

const Audience = "uik-key-v1"

Audience is the JWT audience for UIK API keys.

const Issuer = "goalert"

Issuer is the JWT issuer for UIK API keys.

Types

type InKeySearchOptions

type InKeySearchOptions struct {
	Search string `json:"s,omitempty"`
	After  string `json:"a,omitempty"`

	// Omit specifies a list of key ids to exclude from the results.
	Omit []string `json:"o,omitempty"`

	Limit int `json:"-"`
}

InKeySearchOptions allow filtering and paginating the list of rotations.

type IntegrationKey

type IntegrationKey struct {
	ID        string `json:"id"`
	Name      string `json:"name"`
	Type      Type   `json:"type"`
	ServiceID string `json:"service_id"`

	ExternalSystemName string
}

func (IntegrationKey) Normalize

func (i IntegrationKey) Normalize() (*IntegrationKey, error)

type Store

type Store struct {
	// contains filtered or unexported fields
}

func NewStore

func NewStore(ctx context.Context, db *sql.DB, keys keyring.Keyring, reg *nfydest.Registry, ncStore *notificationchannel.Store) *Store

func (*Store) Authorize

func (s *Store) Authorize(ctx context.Context, tok authtoken.Token, t Type) (context.Context, error)

func (*Store) AuthorizeUIK

func (s *Store) AuthorizeUIK(ctx context.Context, tokStr string) (context.Context, error)

func (*Store) Config

func (s *Store) Config(ctx context.Context, db gadb.DBTX, keyID uuid.UUID) (*gadb.UIKConfigV1, error)

func (*Store) Create

func (s *Store) Create(ctx context.Context, dbtx gadb.DBTX, i *IntegrationKey) (*IntegrationKey, error)

func (*Store) Delete

func (s *Store) Delete(ctx context.Context, dbtx gadb.DBTX, id string) error

func (*Store) DeleteMany

func (s *Store) DeleteMany(ctx context.Context, dbtx gadb.DBTX, ids []string) error

func (*Store) DeleteSecondaryToken

func (s *Store) DeleteSecondaryToken(ctx context.Context, db gadb.DBTX, id uuid.UUID) error

func (*Store) FindAllByService

func (s *Store) FindAllByService(ctx context.Context, serviceID string) ([]IntegrationKey, error)

func (*Store) FindOne

func (s *Store) FindOne(ctx context.Context, id string) (*IntegrationKey, error)

func (*Store) GenerateToken

func (s *Store) GenerateToken(ctx context.Context, db gadb.DBTX, id uuid.UUID) (string, error)

func (*Store) GetServiceID

func (s *Store) GetServiceID(ctx context.Context, id string, t Type) (string, error)

func (*Store) PromoteSecondaryToken

func (s *Store) PromoteSecondaryToken(ctx context.Context, db gadb.DBTX, id uuid.UUID) error

func (*Store) Search

func (s *Store) Search(ctx context.Context, opts *InKeySearchOptions) ([]IntegrationKey, error)

func (*Store) SetConfig

func (s *Store) SetConfig(ctx context.Context, db gadb.DBTX, keyID uuid.UUID, cfg *gadb.UIKConfigV1) error

func (*Store) TokenHints

func (s *Store) TokenHints(ctx context.Context, db gadb.DBTX, id uuid.UUID) (primary, secondary string, err error)

func (*Store) ValidateUIKConfigV1

func (s *Store) ValidateUIKConfigV1(ctx context.Context, cfg gadb.UIKConfigV1) error

type Type

type Type string

Type is the entity that needs an integration.

const (
	TypeGrafana                Type = "grafana"
	TypeSite24x7               Type = "site24x7"
	TypePrometheusAlertmanager Type = "prometheusAlertmanager"
	TypeGeneric                Type = "generic"
	TypeEmail                  Type = "email"
	TypeUniversal              Type = "universal"
)

Types

func (*Type) Scan

func (s *Type) Scan(value interface{}) error

func (Type) Value

func (s Type) Value() (driver.Value, error)