-
Notifications
You must be signed in to change notification settings - Fork 52
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
+105
−3
Merged
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
4587043
Working group proposal for auth
sudo-bmitch 6c48576
Adding owner and stakeholder sections
sudo-bmitch 5f91136
Include auth in list of current working groups
sudo-bmitch 85e17a1
Avoid new functionality
sudo-bmitch 381de56
Adding PR feedback
sudo-bmitch f6b5bd8
Adding owners and stakeholders
sudo-bmitch File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# 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. | ||
* 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 added functionality (e.g. fine grain access control). | ||
sudo-bmitch marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
sudo-bmitch marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## 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. | ||
|
||
## 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. | ||
|
||
## 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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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).