Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Working group proposal for auth #119

Merged
merged 6 commits into from
Jul 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions WG-INFO.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

## List of current OCI Working Groups

* OCI Working Groups approved by the TOB will be listed here, along with each
Working Group's owners and, where applicable following approval of a draft
as an OCI Specification, the Working Group's maintainers.
* [Auth](proposals/wg-auth.md)

## List of disbanded OCI Working Groups

Expand Down
104 changes: 104 additions & 0 deletions proposals/wg-auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# OCI Working Group Proposal: Authentication and Authorization

Proposal created from [OCI WG template](https://github.com/opencontainers/tob/blob/master/WG-TEMPLATE.md).

## Auth OCI Working Group - Governance Charter

This document describes the basic governance principles for the Auth Working Group (the “WG”).

The WG operates as an OCI Working Group under the [Open Container Initiative (OCI) Charter](https://github.com/opencontainers/tob/blob/master/CHARTER.md), which describes the responsibilities of the OCI Technical Oversight Board (the "TOB”).
The WG is established by the TOB as an OCI Working Group pursuant to the OCI Charter.
Accordingly, the WG will operate in accordance with the OCI Charter and OCI's other policies and procedures, supplemented by the details below.

## Purpose

Authentication and authorization are a key requirement for registries to control access.
Implementations of this in registries and clients have roughly followed standards set by Docker and have mostly focused on compatibility with specific implementations of registries or clients.
This working group will define a standard to be supported by OCI compatible registries and clients when support for authentication and authorization is required.

## Scope

* Define registry responses to unauthenticated requests.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this referring to the "anonymous" pull case where an authentication server is giving out tokens for unauthenticated requests?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking of requests where either there is no Authorization header, or the token in the header does not apply to the request (a pull token used to push, or a token for a different repository being reused for a future request).

* Define supported authentication methods (e.g. basic and bearer authentication).
* Specify how clients negotiate access a repository and different types of access to that repository (e.g. pull and push).
* Specify how clients negotiate access to multiple repositories for actions like a cross-repository blob mount.
* Specify how clients and registries should renegotiate access for a request with expired or insufficient authorization.
* Specify expected lifetime of registry credentials.
* Avoid specifications that would prevent future extensibility (e.g. fine grain access control).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does that mean no discussions about ABAC?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say we discuss it enough to know that we aren't excluding the possibility from future specs.

* The authentication methods defined as supported should include OSS solution(s) that avoid picking/choosing a limited set of specific authentication providers as the default / winner.
* Specify how clients and registries should be extensible/pluggable with respect to supported authentication methods.

## Out of Scope

* Registries and clients that do not require authentication and authorization support should be unaffected by these changes.
* How clients store and access credentials, including credential helpers, will remain undefined.
* Significant new functionality, not implemented by existing registries and clients, should not be created.

## Intended work product

* The result of this WG should be a PR to the distribution-spec.
* Effort should be made to avoid breaking changes to existing registries and clients.
* Effort should be made to utilize existing IETF standards when appropriate.

## Proposed Owners

The following have agreed to participate in the working group, review progress, report progress back to the OCI community, and present the results to the TOB once the working group has completed its objectives.

* Brandon Mitchell (@sudo-bmitch)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you mind adding me:
Toddy Mladenov (@toddysm)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rchincha Would you like to be part of the WG? I saw that you added zot below.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, pls add me if no concerns/objections.

* Jason Hall (@imjasonh)
* Jeff Carter (@jcarter3)
* Mike Brown (@mikebrow)
* Ramkumar Chinchani (@rchincha)
* Toddy Mladenov (@toddysm)

## Stakeholders

OCI Projects, non-OCI projects, or organizations sponsoring the working group and participating in the implementation and use case validation of the work done by the group.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the target of this WG is the distribution-spec, are there any other maintainers of the spec who can act as stakeholders?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wave.. I can rep for distribution


* [ACR CLI][acr-cli]
* [Docker Hub][docker-hub]
* [notation][notation]
* [OCI distribution-spec][distribution-spec]
* [oras][oras]
* [regclient][regclient]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can represent the following projects and tools:

oras
notation
ACR CLI

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

zot

* [zot][zot]

## Related Issues/PRs

* <https://github.com/opencontainers/distribution-spec/issues/240>
* <https://github.com/opencontainers/distribution-spec/issues/338>

## Governance

* **Working Group**:
* The TOB is establishing the WG as an OCI Working Group, pursuant to [section 6(p)](https://github.com/opencontainers/tob/blob/master/CHARTER.md#6-technical-oversight-board-tob) of the OCI Charter.
* **Owners**:
* The WG proposal to the TOB will specify one or more initial "owners" of the WG.
* The current owners will be listed in the [OCI Working Group documentation](https://github.com/opencontainers/tob/blob/master/WG-INFO.md).
* The owners shall be responsible for:
* scheduling regular meetings of the WG community;
* facilitating open discussion among WG community participants;
* coordinating and managing the development of the WG work product and outputs;
* recording decisions that are reached by the WG community; and
* keeping the TOB regularly informed about the status of the WG’s efforts, including when the WG has readied the work product and outputs for TOB approval.
* **Maintainers**:
* If the WG owners request the TOB to approve a draft specification as a released OCI Specification, the request shall include a list of proposed "maintainers" of the OCI Specification.
* The current maintainers will be listed in the [OCI Working Group documentation](https://github.com/opencontainers/tob/blob/master/WG-INFO.md).
* The maintainers shall be responsible for continuing the work of overseeing updates, improvements and changes to a released OCI Specification on an ongoing basis.
* **Meetings**:
* Meetings of the WG shall be open to the public.
* Participants in the meetings shall comply with the [OCI Code of Conduct](https://github.com/opencontainers/.github/blob/master/CODE_OF_CONDUCT.md) and all other policies of OCI and The Linux Foundation.
* **TOB Approval**:
* The WG shall operate pursuant to the procedures set forth in [section 6(p)](https://github.com/opencontainers/tob/blob/master/CHARTER.md#6-technical-oversight-board-tob) of the OCI Charter, with regards to obtaining TOB approval for initial release of the work product and outputs as an OCI Specification or other OCI Project, and for subsequent maintenance activities thereafter.
* **Amendments**:
* The owners of the WG may from time to time propose to the TOB (1) amendments to this WG Governance Document, and/or (2) changes to the composition of the owners or maintainers of the WG.
* As set forth in the OCI Charter, the TOB may, in its discretion by a two-thirds vote, approve or reject the requested amendments or changes.
* As set forth in the OCI Charter, the TOB may also disband the WG by a two-thirds vote.

[acr-cli]: https://github.com/Azure/acr-cli
[distribution-spec]: https://github.com/opencontainers/distribution-spec/
[docker-hub]: https://hub.docker.com/
[notation]: https://github.com/notaryproject/notation/
[oras]: https://github.com/oras-project/oras
[regclient]: https://github.com/regclient/regclient
[zot]: https://zotregistry.io/