-
Notifications
You must be signed in to change notification settings - Fork 2
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
[Proposal 005] Node Authorization #8
Open
taniwha3
wants to merge
3
commits into
main
Choose a base branch
from
005-node-authorization
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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,77 @@ | ||
# Design / Feature | ||
|
||
|
||
This feature will allow an administrative user to authenticate with the node. | ||
|
||
#### Scope | ||
This document only covers node authorization. Application authorization is out | ||
of scope for this proposal. | ||
|
||
#### Policy Engine | ||
[Proposal 002](/accepted/002.md) provides the aurae daemon with an SSH | ||
authenticated user based upon SSH Certificates. The selected authentication | ||
provides identity and communication channel encryption. | ||
|
||
Authorization consumes the identity provided by Proposal 002. When the user | ||
connects, the user identity is authenticated directly from the connection. Upon | ||
initial connection, the identity is sent to an authorization plugin. | ||
|
||
The authorization engine receives a message with the identity, action, and | ||
parameters. The authorization engine returns a decision. Aurae Daemon is | ||
responsible for enforcing the decision. | ||
|
||
Authorization decisions are sent to the observability module. | ||
|
||
A simple default policy engine written in rust will be installed when no other | ||
authorization engine has been installed. Users may choose to implement their | ||
own policy engine by implementing the relevant trait. | ||
|
||
Authorization decisions default to deny. | ||
|
||
Not installing a policy engine causes all requests to be denied. | ||
|
||
#### Default Implement | ||
|
||
#### Workflow: | ||
|
||
```mermaid | ||
sequenceDiagram | ||
client-->>auraed: Connect via ssh | ||
auraed-->>policy engine: id, action, parameters | ||
policy engine-->>auraed: decision | ||
note over auraed: enforce | ||
auraed-->>client: status | ||
``` | ||
|
||
### Outcomes | ||
|
||
The outcomes of adding support for policy engines are: | ||
|
||
- auraed will be capable of handling arbitrary scenarios based upon the | ||
connecting client. | ||
- policies may be written in languages designed to deal with policy. | ||
- changes to the policy do not require a recompilation of auraed. | ||
- policy can be centralized for multiple auraed. | ||
|
||
### Goals | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We will need to bake both authn and authz into our standard library, or at the very least call it out of scope.
More on subsystems: https://github.com/aurae-runtime/api/tree/main/spec#aurae-api-specification |
||
|
||
- Aurae Daemon will allow policy engines to be installed. | ||
- Aurae Daemon will produce a single simple policy plugin. | ||
|
||
### Decisions | ||
|
||
- The project will support policy engine plugins. | ||
- The project will only implement a simple policy plugin in rust. | ||
|
||
### Notes | ||
|
||
- The only authorization system that will be implemented in auraed is the | ||
rust implementation. However, this model allows for other organizations | ||
to plugin their own authorization modules to support their own patterns. | ||
See [Zanzibar: Google’s Consistent, Global Authorization System](https://research.google/pubs/pub48190/) | ||
for an example. | ||
|
||
### Authors | ||
|
||
- [@kris-nova](https://github.com/kris-nova) | ||
- [@tani](https://github.com/taniwha3) |
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.
We must must have "reasonable defaults" and opinions. Its a key part of the project.
Is this our reasonable default? Or should we give the user a default policy engine?