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

[Proposal 005] Node Authorization #8

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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
77 changes: 77 additions & 0 deletions accepted/005-node-authentication.md
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.
Copy link
Contributor

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?


#### 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
Copy link
Contributor

Choose a reason for hiding this comment

The 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.

  • Do we have an authn subsystem? Or is this "transparent" based on the aurae.toml?
  • Do we have an authz subsystem? Or is this "transparent" based on the aurae.toml?

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)