Git Product home page Git Product logo

distribution-oauth's Introduction

distribution-oauth

Adapt (semi-)standard OAuth to Docker's token system.

Needs custom registry build because distribution/distribution#2875 (See ghcr.io/beryju/distribution:jwt)

Env variables

  • TOKEN_URL: URL to send POST Token request to
  • CLIENT_ID: OAuth Client ID
  • SCOPE: Special scope to append to requests
  • LOG_LEVEL: Log level, defaults to info, can be set to trace which will print out credentials for debugging

Optional variables

  • ANON_USERNAME: Credentials to be used when the client doesn't send any (optional)
  • ANON_PASSWORD: Credentials to be used when the client doesn't send any (optional)
  • ANON_KUBE_JWT: (Requires kubernetes) If set, will use the current pod's service account as anonymous credentials
  • PASS_JWT_USERNAME: Username clients can use to pass a JWT directly as password (optional)
  • SESSION_KEY: Secret key used for sessions (only used when registry is used in a browser, for example https://github.com/Joxit/docker-registry-ui)

authentik setup

Scope mapping with this code to allow everything:

scopes = request.http_request.POST.get("scope", "").split()
access = []
for scope in scopes:
    if scope.count(":") < 2:
        continue
    type, name, actions = scope.split(":")
    access.append({
        "type": type,
        "name": name,
        "actions": actions.split(","),
    })
return {
    "access": access,
}

Create with unique scope name, add scope to provider and configure env correctly

distribution-oauth's People

Contributors

beryju avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.