zitadel/internal/eventstore/aggregate.go
Tim Möhlmann 64a3bb3149
feat(v3alpha): web key resource (#8262)
# Which Problems Are Solved

Implement a new API service that allows management of OIDC signing web
keys.
This allows users to manage rotation of the instance level keys. which
are currently managed based on expiry.

The API accepts the generation of the following key types and
parameters:

- RSA keys with 2048, 3072 or 4096 bit in size and:
  - Signing with SHA-256 (RS256)
  - Signing with SHA-384 (RS384)
  - Signing with SHA-512 (RS512)
- ECDSA keys with
  - P256 curve
  - P384 curve
  - P512 curve
- ED25519 keys

# How the Problems Are Solved

Keys are serialized for storage using the JSON web key format from the
`jose` library. This is the format that will be used by OIDC for
signing, verification and publication.

Each instance can have a number of key pairs. All existing public keys
are meant to be used for token verification and publication the keys
endpoint. Keys can be activated and the active private key is meant to
sign new tokens. There is always exactly 1 active signing key:

1. When the first key for an instance is generated, it is automatically
activated.
2. Activation of the next key automatically deactivates the previously
active key.
3. Keys cannot be manually deactivated from the API
4. Active keys cannot be deleted

# Additional Changes

- Query methods that later will be used by the OIDC package are already
implemented. Preparation for #8031
- Fix indentation in french translation for instance event
- Move user_schema translations to consistent positions in all
translation files

# Additional Context

- Closes #8030
- Part of #7809

---------

Co-authored-by: Elio Bischof <elio@zitadel.com>
2024-08-14 14:18:14 +00:00

112 lines
2.6 KiB
Go

package eventstore
import (
"context"
"github.com/zitadel/zitadel/internal/api/authz"
)
type aggregateOpt func(*Aggregate)
// NewAggregate is the default constructor of an aggregate
// opts overwrite values calculated by given parameters
func NewAggregate(
ctx context.Context,
id string,
typ AggregateType,
version Version,
opts ...aggregateOpt,
) *Aggregate {
a := &Aggregate{
ID: id,
Type: typ,
ResourceOwner: authz.GetCtxData(ctx).OrgID,
InstanceID: authz.GetInstance(ctx).InstanceID(),
Version: version,
}
for _, opt := range opts {
opt(a)
}
return a
}
// WithResourceOwner overwrites the resource owner of the aggregate
// by default the resource owner is set by the context
func WithResourceOwner(resourceOwner string) aggregateOpt {
return func(aggregate *Aggregate) {
aggregate.ResourceOwner = resourceOwner
}
}
// WithInstanceID overwrites the instance id of the aggregate
// by default the instance is set by the context
func WithInstanceID(id string) aggregateOpt {
return func(aggregate *Aggregate) {
aggregate.InstanceID = id
}
}
// AggregateFromWriteModel maps the given WriteModel to an Aggregate.
// Deprecated: Creates linter errors on missing context. Use [AggregateFromWriteModelCtx] instead.
func AggregateFromWriteModel(
wm *WriteModel,
typ AggregateType,
version Version,
) *Aggregate {
return AggregateFromWriteModelCtx(context.Background(), wm, typ, version)
}
// AggregateFromWriteModelCtx maps the given WriteModel to an Aggregate.
func AggregateFromWriteModelCtx(
ctx context.Context,
wm *WriteModel,
typ AggregateType,
version Version,
) *Aggregate {
return NewAggregate(
ctx,
wm.AggregateID,
typ,
version,
WithResourceOwner(wm.ResourceOwner),
WithInstanceID(wm.InstanceID),
)
}
// Aggregate is the basic implementation of Aggregater
type Aggregate struct {
// ID is the unique identitfier of this aggregate
ID string `json:"-"`
// Type is the name of the aggregate.
Type AggregateType `json:"-"`
// ResourceOwner is the org this aggregates belongs to
ResourceOwner string `json:"-"`
// InstanceID is the instance this aggregate belongs to
InstanceID string `json:"-"`
// Version is the semver this aggregate represents
Version Version `json:"-"`
}
// AggregateType is the object name
type AggregateType string
func isAggregateTypes(a *Aggregate, types ...AggregateType) bool {
for _, typ := range types {
if a.Type == typ {
return true
}
}
return false
}
func isAggregateIDs(a *Aggregate, ids ...string) bool {
for _, id := range ids {
if a.ID == id {
return true
}
}
return false
}