2022-06-03 12:13:31 -04:00
|
|
|
// Copyright (c) HashiCorp, Inc.
|
|
|
|
|
// SPDX-License-Identifier: BUSL-1.1
|
2023-02-02 17:15:17 -08:00
|
|
|
|
2022-06-03 12:13:31 -04:00
|
|
|
package servers
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"context"
|
|
|
|
|
"time"
|
|
|
|
|
|
|
|
|
|
"github.com/hashicorp/boundary/internal/db"
|
|
|
|
|
"github.com/hashicorp/boundary/internal/errors"
|
|
|
|
|
"github.com/hashicorp/boundary/internal/kms"
|
|
|
|
|
"github.com/hashicorp/boundary/internal/scheduler"
|
2022-06-20 18:20:17 -07:00
|
|
|
"github.com/hashicorp/boundary/internal/server"
|
2023-05-17 18:12:19 -04:00
|
|
|
"github.com/hashicorp/nodeenrollment"
|
2022-06-03 12:13:31 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// rotateRootsJob defines a periodic job that initiates root certificate rotation
|
|
|
|
|
// It runs every hour; the root rotation function in the library is designed to not
|
|
|
|
|
// do anything if it's not time to rotate (roots are within their valid ranges)
|
|
|
|
|
type rotateRootsJob struct {
|
2022-06-20 18:20:17 -07:00
|
|
|
workerAuthRepo *server.WorkerAuthRepositoryStorage
|
2022-06-03 12:13:31 -04:00
|
|
|
|
|
|
|
|
totalRotates int
|
2023-05-17 18:12:19 -04:00
|
|
|
|
|
|
|
|
rotateFrequency time.Duration
|
|
|
|
|
|
|
|
|
|
certificateLifetime time.Duration
|
2022-06-03 12:13:31 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// newRotateRootsJob instantiates the rotate roots job.
|
2023-05-17 18:12:19 -04:00
|
|
|
func newRotateRootsJob(ctx context.Context, r db.Reader, w db.Writer, kms *kms.Kms, opt ...Option) (*rotateRootsJob, error) {
|
2022-06-20 18:20:17 -07:00
|
|
|
const op = "server.newRotateRootsJob"
|
2022-06-03 12:13:31 -04:00
|
|
|
switch {
|
|
|
|
|
case isNil(r):
|
|
|
|
|
return nil, errors.New(ctx, errors.InvalidParameter, op, "missing reader")
|
|
|
|
|
case isNil(w):
|
|
|
|
|
return nil, errors.New(ctx, errors.InvalidParameter, op, "missing writer")
|
|
|
|
|
case kms == nil:
|
|
|
|
|
return nil, errors.New(ctx, errors.InvalidParameter, op, "missing kms")
|
|
|
|
|
}
|
|
|
|
|
|
2022-06-20 18:20:17 -07:00
|
|
|
workerAuthRepo, err := server.NewRepositoryStorage(ctx, r, w, kms)
|
2022-06-03 12:13:31 -04:00
|
|
|
if err != nil {
|
|
|
|
|
return nil, errors.Wrap(ctx, err, op)
|
|
|
|
|
}
|
|
|
|
|
|
2023-05-17 18:12:19 -04:00
|
|
|
opts := getOpts(opt...)
|
|
|
|
|
|
2022-06-03 12:13:31 -04:00
|
|
|
return &rotateRootsJob{
|
2023-05-17 18:12:19 -04:00
|
|
|
workerAuthRepo: workerAuthRepo,
|
|
|
|
|
totalRotates: 0,
|
|
|
|
|
rotateFrequency: opts.withRotationFrequency,
|
|
|
|
|
certificateLifetime: opts.withCertificateLifetime,
|
2022-06-03 12:13:31 -04:00
|
|
|
}, nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Name returns a short, unique name for the job.
|
|
|
|
|
func (r *rotateRootsJob) Name() string { return "rotate_roots" }
|
|
|
|
|
|
|
|
|
|
// Description returns the description for the job.
|
|
|
|
|
func (r *rotateRootsJob) Description() string {
|
|
|
|
|
return "Rotate root certificates"
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// NextRunIn returns the next run time after a job is completed.
|
|
|
|
|
// This is represented by RotateFrequency
|
|
|
|
|
func (r *rotateRootsJob) NextRunIn(_ context.Context) (time.Duration, error) {
|
2023-05-17 18:12:19 -04:00
|
|
|
return r.rotateFrequency, nil
|
2022-06-03 12:13:31 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Status returns the status of the running job.
|
|
|
|
|
func (r *rotateRootsJob) Status() scheduler.JobStatus {
|
|
|
|
|
return scheduler.JobStatus{
|
|
|
|
|
Completed: r.totalRotates,
|
|
|
|
|
Total: r.totalRotates,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Run executes the job by calling the rotateRoots domain function
|
2024-09-20 12:14:29 -04:00
|
|
|
func (r *rotateRootsJob) Run(ctx context.Context, _ time.Duration) error {
|
2022-06-20 18:20:17 -07:00
|
|
|
const op = "server.(rotateRootsJob).Run"
|
2022-06-03 12:13:31 -04:00
|
|
|
|
2023-05-17 18:12:19 -04:00
|
|
|
_, err := server.RotateRoots(ctx, r.workerAuthRepo, nodeenrollment.WithCertificateLifetime(r.certificateLifetime))
|
2022-06-03 12:13:31 -04:00
|
|
|
if err != nil {
|
|
|
|
|
return errors.Wrap(ctx, err, op)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
r.totalRotates += 1
|
|
|
|
|
|
|
|
|
|
return nil
|
|
|
|
|
}
|