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 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
|
// Package modregistrytest provides helpers for testing packages
// which interact with CUE registries.
//
// WARNING: THIS PACKAGE IS EXPERIMENTAL.
// ITS API MAY CHANGE AT ANY TIME.
package modregistrytest
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"io/fs"
"maps"
"net/http"
"net/http/httptest"
"net/url"
"regexp"
"slices"
"strings"
"cuelabs.dev/go/oci/ociregistry"
"cuelabs.dev/go/oci/ociregistry/ocifilter"
"cuelabs.dev/go/oci/ociregistry/ocimem"
"cuelabs.dev/go/oci/ociregistry/ociserver"
"golang.org/x/tools/txtar"
"cuelang.org/go/mod/modfile"
"cuelang.org/go/mod/modregistry"
"cuelang.org/go/mod/module"
"cuelang.org/go/mod/modzip"
)
// AuthConfig specifies authorization requirements for the server.
type AuthConfig struct {
// Username and Password hold the basic auth credentials.
// If UseTokenServer is true, these apply to the token server
// rather than to the registry itself.
Username string `json:"username"`
Password string `json:"password"`
// BearerToken holds a bearer token to use as auth.
// If UseTokenServer is true, this applies to the token server
// rather than to the registry itself.
BearerToken string `json:"bearerToken"`
// UseTokenServer starts a token server and directs client
// requests to acquire auth tokens from that server.
UseTokenServer bool `json:"useTokenServer"`
// ACL holds the ACL for an authenticated client.
// If it's nil, the user is allowed full access.
// Note: there's only one ACL because we only
// support a single authenticated user.
ACL *ACL `json:"acl,omitempty"`
// Use401InsteadOf403 causes the server to send a 401
// response even when the credentials are present and correct.
Use401InsteadOf403 bool `json:"always401"`
}
// ACL determines what endpoints an authenticated user can accesse
// Both Allow and Deny hold a list of regular expressions that
// are matched against an HTTP request formatted as a string:
//
// METHOD URL_PATH
//
// For example:
//
// GET /v2/foo/bar
type ACL struct {
// Allow holds the list of allowed paths for a user.
// If none match, the user is forbidden.
Allow []string
// Deny holds the list of denied paths for a user.
// If any match, the user is forbidden.
Deny []string
}
// Upload uploads the modules found inside fsys (stored
// in the format described by [New]) to the given registry.
func Upload(ctx context.Context, r ociregistry.Interface, fsys fs.FS) error {
_, err := upload(ctx, r, fsys)
return err
}
func upload(ctx context.Context, r ociregistry.Interface, fsys fs.FS) (authConfig []byte, err error) {
client := modregistry.NewClient(r)
mods, authConfigData, err := getModules(fsys)
if err != nil {
return nil, fmt.Errorf("invalid modules: %v", err)
}
if err := pushContent(ctx, client, mods); err != nil {
return nil, fmt.Errorf("cannot push modules: %v", err)
}
return authConfigData, nil
}
// New starts a registry instance that serves modules found inside fsys.
// It serves the OCI registry protocol.
// If prefix is non-empty, all module paths will be prefixed by that,
// separated by a slash (/).
//
// Each module should be inside a directory named path_vers, where
// slashes in path have been replaced with underscores and should
// contain a cue.mod/module.cue file holding the module info.
//
// If there's a file named auth.json in the root directory,
// it will cause access to the server to be gated by the
// specified authorization. See the [AuthConfig] type for
// details.
//
// The Registry should be closed after use.
func New(fsys fs.FS, prefix string) (*Registry, error) {
r := ocimem.NewWithConfig(&ocimem.Config{ImmutableTags: true})
authConfigData, err := upload(context.Background(), ocifilter.Sub(r, prefix), fsys)
if err != nil {
return nil, err
}
var authConfig *AuthConfig
if authConfigData != nil {
if err := json.Unmarshal(authConfigData, &authConfig); err != nil {
return nil, fmt.Errorf("invalid auth.json: %v", err)
}
}
return NewServer(ocifilter.ReadOnly(r), authConfig)
}
// NewServer is like New except that instead of uploading
// the contents of a filesystem, it just serves the contents
// of the given registry guarded by the given auth configuration.
// If auth is nil, no authentication will be required.
func NewServer(r ociregistry.Interface, auth *AuthConfig) (*Registry, error) {
var tokenSrv *httptest.Server
if auth != nil && auth.UseTokenServer {
tokenSrv = httptest.NewServer(tokenHandler(auth))
}
r, err := authzRegistry(auth, r)
if err != nil {
return nil, err
}
srv := httptest.NewServer(®istryHandler{
auth: auth,
registry: ociserver.New(r, nil),
tokenSrv: tokenSrv,
})
u, err := url.Parse(srv.URL)
if err != nil {
return nil, err
}
return &Registry{
srv: srv,
host: u.Host,
tokenSrv: tokenSrv,
}, nil
}
// authzRegistry wraps r by checking whether the client has authorization
// to read any given repository.
func authzRegistry(auth *AuthConfig, r ociregistry.Interface) (ociregistry.Interface, error) {
if auth == nil {
return r, nil
}
allow := func(repoName string) bool {
return true
}
if auth.ACL != nil {
allowCheck, err := regexpMatcher(auth.ACL.Allow)
if err != nil {
return nil, fmt.Errorf("invalid allow list: %v", err)
}
denyCheck, err := regexpMatcher(auth.ACL.Deny)
if err != nil {
return nil, fmt.Errorf("invalid deny list: %v", err)
}
allow = func(repoName string) bool {
return allowCheck(repoName) && !denyCheck(repoName)
}
}
return ocifilter.AccessChecker(r, func(repoName string, access ocifilter.AccessKind) (_err error) {
if !allow(repoName) {
if auth.Use401InsteadOf403 {
// TODO this response should be associated with a
// Www-Authenticate header, but this won't do that.
// Given that the ociauth logic _should_ turn
// this back into a 403 error again, perhaps
// we're OK.
return ociregistry.ErrUnauthorized
}
// TODO should we be a bit more sophisticated and only
// return ErrDenied when the repository doesn't exist?
return ociregistry.ErrDenied
}
return nil
}), nil
}
func regexpMatcher(patStrs []string) (func(string) bool, error) {
pats := make([]*regexp.Regexp, len(patStrs))
for i, s := range patStrs {
pat, err := regexp.Compile(s)
if err != nil {
return nil, fmt.Errorf("invalid regexp in ACL: %v", err)
}
pats[i] = pat
}
return func(name string) bool {
for _, pat := range pats {
if pat.MatchString(name) {
return true
}
}
return false
}, nil
}
type registryHandler struct {
auth *AuthConfig
registry http.Handler
tokenSrv *httptest.Server
}
const (
registryAuthToken = "ok-token-for-registrytest"
registryUnauthToken = "unauth-token-for-registrytest"
)
func (h *registryHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
if h.auth == nil {
h.registry.ServeHTTP(w, req)
return
}
if h.tokenSrv == nil {
h.serveDirectAuth(w, req)
return
}
// Auth with token server.
wwwAuth := fmt.Sprintf("Bearer realm=%q,service=registrytest", h.tokenSrv.URL)
authHeader := req.Header.Get("Authorization")
if authHeader == "" {
w.Header().Set("Www-Authenticate", wwwAuth)
writeError(w, ociregistry.ErrUnauthorized)
return
}
kind, token, ok := strings.Cut(authHeader, " ")
if !ok || kind != "Bearer" {
w.Header().Set("Www-Authenticate", wwwAuth)
writeError(w, ociregistry.ErrUnauthorized)
return
}
switch token {
case registryAuthToken:
// User is authorized.
case registryUnauthToken:
writeError(w, ociregistry.ErrDenied)
return
default:
// If we don't recognize the token, then presumably
// the client isn't authenticated so it's 401 not 403.
w.Header().Set("Www-Authenticate", wwwAuth)
writeError(w, ociregistry.ErrUnauthorized)
return
}
// If the underlying registry returns a 401 error,
// we need to add the Www-Authenticate header.
// As there's no way to get ociserver to do it,
// we hack it by wrapping the ResponseWriter
// with an implementation that does.
h.registry.ServeHTTP(&authHeaderWriter{
wwwAuth: wwwAuth,
ResponseWriter: w,
}, req)
}
func (h *registryHandler) serveDirectAuth(w http.ResponseWriter, req *http.Request) {
auth := req.Header.Get("Authorization")
if auth == "" {
if h.auth.BearerToken != "" {
// Note that this lacks information like the realm,
// but we don't need it for our test cases yet.
w.Header().Set("Www-Authenticate", "Bearer service=registry")
} else {
w.Header().Set("Www-Authenticate", "Basic service=registry")
}
writeError(w, fmt.Errorf("%w: no credentials", ociregistry.ErrUnauthorized))
return
}
if h.auth.BearerToken != "" {
token, ok := strings.CutPrefix(auth, "Bearer ")
if !ok || token != h.auth.BearerToken {
writeError(w, fmt.Errorf("%w: invalid bearer credentials", ociregistry.ErrUnauthorized))
return
}
} else {
username, password, ok := req.BasicAuth()
if !ok || username != h.auth.Username || password != h.auth.Password {
writeError(w, fmt.Errorf("%w: invalid user-password credentials", ociregistry.ErrUnauthorized))
return
}
}
h.registry.ServeHTTP(w, req)
}
func tokenHandler(*AuthConfig) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
if req.Method != "POST" {
http.Error(w, "only POST supported", http.StatusMethodNotAllowed)
return
}
req.ParseForm()
if req.Form.Get("service") != "registrytest" {
http.Error(w, "invalid service", http.StatusBadRequest)
return
}
if req.Form.Get("grant_type") != "refresh_token" {
http.Error(w, "invalid grant type", http.StatusBadRequest)
return
}
refreshToken := req.Form.Get("refresh_token")
if refreshToken != "registrytest-refresh" {
http.Error(w, fmt.Sprintf("invalid refresh token %q", refreshToken), http.StatusForbidden)
return
}
// See ociauth.wireToken for the full JSON format.
data, _ := json.Marshal(map[string]string{
"token": registryAuthToken,
})
w.Header().Set("Content-Type", "application/json")
w.Write(data)
})
}
func writeError(w http.ResponseWriter, err error) {
data, httpStatus := ociregistry.MarshalError(err)
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(httpStatus)
w.Write(data)
}
func pushContent(ctx context.Context, client *modregistry.Client, mods map[module.Version]*moduleContent) error {
pushed := make(map[module.Version]bool)
// Iterate over modules in deterministic order.
for _, v := range slices.SortedFunc(maps.Keys(mods), module.Version.Compare) {
err := visitDepthFirst(mods, v, func(v module.Version, m *moduleContent) error {
if pushed[v] {
return nil
}
var zipContent bytes.Buffer
if err := m.writeZip(&zipContent); err != nil {
return err
}
if err := client.PutModule(ctx, v, bytes.NewReader(zipContent.Bytes()), int64(zipContent.Len())); err != nil {
return err
}
pushed[v] = true
return nil
})
if err != nil {
return err
}
}
return nil
}
func visitDepthFirst(mods map[module.Version]*moduleContent, v module.Version, f func(module.Version, *moduleContent) error) error {
m := mods[v]
if m == nil {
return nil
}
for _, depv := range m.modFile.DepVersions() {
if err := visitDepthFirst(mods, depv, f); err != nil {
return err
}
}
return f(v, m)
}
type Registry struct {
srv *httptest.Server
tokenSrv *httptest.Server
host string
}
func (r *Registry) Close() {
r.srv.Close()
if r.tokenSrv != nil {
r.tokenSrv.Close()
}
}
type authHeaderWriter struct {
wwwAuth string
http.ResponseWriter
}
func (w *authHeaderWriter) WriteHeader(code int) {
if code == http.StatusUnauthorized && w.Header().Get("Www-Authenticate") == "" {
w.Header().Set("Www-Authenticate", w.wwwAuth)
}
w.ResponseWriter.WriteHeader(code)
}
// Host returns the hostname for the registry server;
// for example localhost:13455.
//
// The connection can be assumed to be insecure.
func (r *Registry) Host() string {
return r.host
}
func getModules(fsys fs.FS) (map[module.Version]*moduleContent, []byte, error) {
var authConfig []byte
modules := make(map[string]*moduleContent)
if err := fs.WalkDir(fsys, ".", func(path string, d fs.DirEntry, err error) error {
if err != nil {
// If a filesystem has no entries at all,
// return zero modules without an error.
if path == "." && errors.Is(err, fs.ErrNotExist) {
return fs.SkipAll
}
return err
}
if d.IsDir() {
return nil // we're only interested in regular files, not their parent directories
}
if path == "auth.json" {
authConfig, err = fs.ReadFile(fsys, path)
if err != nil {
return err
}
return nil
}
modver, rest, ok := strings.Cut(path, "/")
if !ok {
return fmt.Errorf("registry should only contain directories, but found regular file %q", path)
}
content := modules[modver]
if content == nil {
content = &moduleContent{}
modules[modver] = content
}
data, err := fs.ReadFile(fsys, path)
if err != nil {
return err
}
content.files = append(content.files, txtar.File{
Name: rest,
Data: data,
})
return nil
}); err != nil {
return nil, nil, err
}
for modver, content := range modules {
if err := content.init(modver); err != nil {
return nil, nil, fmt.Errorf("cannot initialize module %q: %v", modver, err)
}
}
byVer := map[module.Version]*moduleContent{}
for _, m := range modules {
byVer[m.version] = m
}
return byVer, authConfig, nil
}
type moduleContent struct {
version module.Version
files []txtar.File
modFile *modfile.File
}
func (c *moduleContent) writeZip(w io.Writer) error {
return modzip.Create(w, c.version, c.files, txtarFileIO{})
}
func (c *moduleContent) init(versDir string) error {
found := false
for _, f := range c.files {
if f.Name != "cue.mod/module.cue" {
continue
}
modf, err := modfile.Parse(f.Data, f.Name)
if err != nil {
return err
}
if found {
return fmt.Errorf("multiple module.cue files")
}
mod := strings.ReplaceAll(modf.ModuleRootPath(), "/", "_") + "_"
vers := strings.TrimPrefix(versDir, mod)
if len(vers) == len(versDir) {
return fmt.Errorf("module path %q in module.cue does not match directory %q", modf.QualifiedModule(), versDir)
}
v, err := module.NewVersion(modf.QualifiedModule(), vers)
if err != nil {
return fmt.Errorf("cannot make module version: %v", err)
}
c.version = v
c.modFile = modf
found = true
}
if !found {
return fmt.Errorf("no module.cue file found in %q", versDir)
}
return nil
}
|