1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
|
// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (C) 2015-2023 Canonical Ltd
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package asserts
import (
"errors"
"fmt"
"regexp"
"time"
)
var validAccountKeyName = regexp.MustCompile(`^(?:[a-z0-9]+-?)*[a-z](?:-?[a-z0-9])*$`)
// AccountKey holds an account-key assertion, asserting a public key
// belonging to the account.
type AccountKey struct {
assertionBase
sinceUntil
constraintMatchers []attrMatcher
pubKey PublicKey
}
type sinceUntil struct {
since time.Time
until time.Time
}
func checkSinceUntilWhat(m map[string]any, what string) (*sinceUntil, error) {
since, err := checkRFC3339DateWhat(m, "since", what)
if err != nil {
return nil, err
}
until, err := checkRFC3339DateWithDefaultWhat(m, "until", what, time.Time{})
if err != nil {
return nil, err
}
if !until.IsZero() && until.Before(since) {
return nil, fmt.Errorf("'until' time cannot be before 'since' time")
}
return &sinceUntil{
since: since,
until: until,
}, nil
}
// AccountID returns the account-id of this account-key.
func (ak *AccountKey) AccountID() string {
return ak.HeaderString("account-id")
}
// Name returns the name of the account key.
func (ak *AccountKey) Name() string {
return ak.HeaderString("name")
}
func IsValidAccountKeyName(name string) bool {
return validAccountKeyName.MatchString(name)
}
// Since returns the time when the account key starts being valid.
func (ak *AccountKey) Since() time.Time {
return ak.since
}
// Until returns the time when the account key stops being valid. A zero time means the key is valid forever.
func (ak *AccountKey) Until() time.Time {
return ak.until
}
// PublicKeyID returns the key id used for lookup of the account key.
func (ak *AccountKey) PublicKeyID() string {
return ak.pubKey.ID()
}
// isValidAt returns whether the since-until constraint is valid at 'when' time.
func (su *sinceUntil) isValidAt(when time.Time) bool {
valid := when.After(su.since) || when.Equal(su.since)
if valid && !su.until.IsZero() {
valid = when.Before(su.until)
}
return valid
}
// isValidAssumingCurTimeWithin returns whether the since-until constraint is
// possibly valid if the current time is known to be within [earliest,
// latest]. That means the intersection of possible current times and
// validity is not empty.
// If latest is zero, then current time is assumed to be >=earliest.
// If earliest == latest this is equivalent to isKeyValidAt().
func (su *sinceUntil) isValidAssumingCurTimeWithin(earliest, latest time.Time) bool {
if !latest.IsZero() {
// impossible input => false
if latest.Before(earliest) {
return false
}
if latest.Before(su.since) {
return false
}
}
if !su.until.IsZero() {
if earliest.After(su.until) || earliest.Equal(su.until) {
return false
}
}
return true
}
// publicKey returns the underlying public key of the account key.
func (ak *AccountKey) publicKey() PublicKey {
return ak.pubKey
}
// ConstraintsPrecheck checks whether the given type and headers match the signing constraints of the account key.
func (ak *AccountKey) ConstraintsPrecheck(assertType *AssertionType, headers map[string]any) error {
headersWithType := copyHeaders(headers)
headersWithType["type"] = assertType.Name
if !ak.matchAgainstConstraints(headersWithType) {
return fmt.Errorf("headers do not match the account-key constraints")
}
return nil
}
func (ak *AccountKey) matchAgainstConstraints(headers map[string]any) bool {
matchers := ak.constraintMatchers
// no constraints, everything is allowed
if len(matchers) == 0 {
return true
}
for _, m := range matchers {
if m.match("", headers, &attrMatchingContext{
attrWord: "header",
}) == nil {
return true
}
}
return false
}
// canSign checks whether the given assertion matches the signing constraints of the account key.
func (ak *AccountKey) canSign(a Assertion) bool {
return ak.matchAgainstConstraints(a.Headers())
}
func checkPublicKey(ab *assertionBase, keyIDName string) (PublicKey, error) {
pubKey, err := DecodePublicKey(ab.Body())
if err != nil {
return nil, err
}
keyID, err := checkNotEmptyString(ab.headers, keyIDName)
if err != nil {
return nil, err
}
if keyID != pubKey.ID() {
return nil, fmt.Errorf("public key does not match provided key id")
}
return pubKey, nil
}
// Implement further consistency checks.
func (ak *AccountKey) checkConsistency(db RODatabase, acck *AccountKey) error {
if !db.IsTrustedAccount(ak.AuthorityID()) {
return fmt.Errorf("account-key assertion for %q is not signed by a directly trusted authority: %s", ak.AccountID(), ak.AuthorityID())
}
_, err := db.Find(AccountType, map[string]string{
"account-id": ak.AccountID(),
})
if errors.Is(err, &NotFoundError{}) {
return fmt.Errorf("account-key assertion for %q does not have a matching account assertion", ak.AccountID())
}
if err != nil {
return err
}
// XXX: Make this unconditional once account-key assertions are required to have a name.
if ak.Name() != "" {
// Check that we don't end up with multiple keys with
// different IDs but the same account-id and name.
// Note that this is a non-transactional check-then-add, so
// is not a hard guarantee. Backstores that can implement a
// unique constraint should do so.
assertions, err := db.FindMany(AccountKeyType, map[string]string{
"account-id": ak.AccountID(),
"name": ak.Name(),
})
if err != nil && !errors.Is(err, &NotFoundError{}) {
return err
}
for _, assertion := range assertions {
existingAccKey := assertion.(*AccountKey)
if ak.PublicKeyID() != existingAccKey.PublicKeyID() {
return fmt.Errorf("account-key assertion for %q with ID %q has the same name %q as existing ID %q", ak.AccountID(), ak.PublicKeyID(), ak.Name(), existingAccKey.PublicKeyID())
}
}
}
return nil
}
// expected interface is implemented
var _ consistencyChecker = (*AccountKey)(nil)
// Prerequisites returns references to this account-key's prerequisite assertions.
func (ak *AccountKey) Prerequisites() []*Ref {
return []*Ref{
{Type: AccountType, PrimaryKey: []string{ak.AccountID()}},
}
}
func assembleAccountKey(assert assertionBase) (Assertion, error) {
_, err := checkNotEmptyString(assert.headers, "account-id")
if err != nil {
return nil, err
}
// XXX: We should require name to be present after backfilling existing assertions.
_, ok := assert.headers["name"]
if ok {
_, err = checkStringMatches(assert.headers, "name", validAccountKeyName)
if err != nil {
return nil, err
}
}
sinceUntil, err := checkSinceUntilWhat(assert.headers, "header")
if err != nil {
return nil, err
}
pubk, err := checkPublicKey(&assert, "public-key-sha3-384")
if err != nil {
return nil, err
}
var matchers []attrMatcher
if cs, ok := assert.headers["constraints"]; ok {
matchers, err = checkAKConstraints(cs)
if err != nil {
return nil, err
}
}
// ignore extra headers for future compatibility
return &AccountKey{
assertionBase: assert,
sinceUntil: *sinceUntil,
constraintMatchers: matchers,
pubKey: pubk,
}, nil
}
func checkAKConstraints(cs any) ([]attrMatcher, error) {
csmaps, ok := cs.([]any)
if !ok {
return nil, fmt.Errorf("assertions constraints must be a list of maps")
}
if len(csmaps) == 0 {
// there is no syntax producing this scenario but be robust
return nil, fmt.Errorf("assertions constraints cannot be empty")
}
matchers := make([]attrMatcher, 0, len(csmaps))
for _, csmap := range csmaps {
m, ok := csmap.(map[string]any)
if !ok {
return nil, fmt.Errorf("assertions constraints must be a list of maps")
}
hm, err := checkMapWhat(m, "headers", "constraint")
if err != nil {
return nil, err
}
if hm == nil {
return nil, fmt.Errorf(`"headers" constraint mandatory in asserions constraints`)
}
t, ok := hm["type"]
if !ok {
return nil, fmt.Errorf("type header constraint mandatory in asserions constraints")
}
tstr, ok := t.(string)
if !ok {
return nil, fmt.Errorf("type header constraint must be a string")
}
if tstr != regexp.QuoteMeta(tstr) {
return nil, fmt.Errorf("type header constraint must be a precise string and not a regexp")
}
cc := compileContext{
opts: &compileAttrMatcherOptions{},
}
matcher, err := compileAttrMatcher(cc, hm)
if err != nil {
return nil, fmt.Errorf("cannot compile headers constraint: %v", err)
}
matchers = append(matchers, matcher)
}
return matchers, nil
}
func accountKeyFormatAnalyze(headers map[string]any, body []byte) (formatnum int, err error) {
formatnum = 0
if _, ok := headers["constraints"]; ok {
formatnum = 1
}
return formatnum, nil
}
// AccountKeyRequest holds an account-key-request assertion, which is a self-signed request to prove that the requester holds the private key and wishes to create an account-key assertion for it.
type AccountKeyRequest struct {
assertionBase
sinceUntil
pubKey PublicKey
}
// AccountID returns the account-id of this account-key-request.
func (akr *AccountKeyRequest) AccountID() string {
return akr.HeaderString("account-id")
}
// Name returns the name of the account key.
func (akr *AccountKeyRequest) Name() string {
return akr.HeaderString("name")
}
// Since returns the time when the requested account key starts being valid.
func (akr *AccountKeyRequest) Since() time.Time {
return akr.since
}
// Until returns the time when the requested account key stops being valid. A zero time means the key is valid forever.
func (akr *AccountKeyRequest) Until() time.Time {
return akr.until
}
// PublicKeyID returns the underlying public key ID of the requested account key.
func (akr *AccountKeyRequest) PublicKeyID() string {
return akr.pubKey.ID()
}
// signKey returns the underlying public key of the requested account key.
func (akr *AccountKeyRequest) signKey(db RODatabase) (PublicKey, error) {
return akr.pubKey, nil
}
// Implement further consistency checks.
func (akr *AccountKeyRequest) checkConsistency(db RODatabase, acck *AccountKey) error {
_, err := db.Find(AccountType, map[string]string{
"account-id": akr.AccountID(),
})
if errors.Is(err, &NotFoundError{}) {
return fmt.Errorf("account-key-request assertion for %q does not have a matching account assertion", akr.AccountID())
}
if err != nil {
return err
}
return nil
}
// expected interfaces are implemented
var (
_ consistencyChecker = (*AccountKeyRequest)(nil)
_ customSigner = (*AccountKeyRequest)(nil)
)
// Prerequisites returns references to this account-key-request's prerequisite assertions.
func (akr *AccountKeyRequest) Prerequisites() []*Ref {
return []*Ref{
{Type: AccountType, PrimaryKey: []string{akr.AccountID()}},
}
}
func assembleAccountKeyRequest(assert assertionBase) (Assertion, error) {
_, err := checkNotEmptyString(assert.headers, "account-id")
if err != nil {
return nil, err
}
_, err = checkStringMatches(assert.headers, "name", validAccountKeyName)
if err != nil {
return nil, err
}
sinceUntil, err := checkSinceUntilWhat(assert.headers, "header")
if err != nil {
return nil, err
}
pubk, err := checkPublicKey(&assert, "public-key-sha3-384")
if err != nil {
return nil, err
}
// XXX TODO: support constraints also in account-key-request when
// implementing more fully automated registration flows
// ignore extra headers for future compatibility
return &AccountKeyRequest{
assertionBase: assert,
sinceUntil: *sinceUntil,
pubKey: pubk,
}, nil
}
|