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.

Sign up for GitHub

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

Jump to bottom

gnmi: standardise metadata username/password keys #183

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

gnmi: standardise metadata username/password keys #183

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions rpc/gnmi/gnmi-authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,19 @@ performant solution.
Subscribe and Get RPCs do not make configuration changes to a device and thus should be allowed for users with Read-Only or
Read-Write permissions.

#### Metadata standards
<ul>
gRPC specifies <a href="https://grpc.io/docs/what-is-grpc/core-concepts/#metadata">metadata</a> as a list of arbitrary key/value pairs.<br>
The following metadata key/value pairs are therefore standardised across gNMI/gNOI for cases where metadata is involved in authentication:

| Key | Value |
|--------------|-----------------|
| `"username"` | client username |
| `"password"` | client password |
</ul>
Comment on lines +58 to +67
Copy link
Contributor

Choose a reason for hiding this comment

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

NIT: there seems to be no need in using HTML inside this markdown
ul and br can be omitted

Copy link
Author

@brianneville brianneville Mar 20, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

They're just being used to indent the table and text to be aligned with the other lists above
for example:

heading

    some text
    Key Value
    "username" client username
    "password" client password

vs

heading

some text

Key Value
"username" client username
"password" client password

I think the first one looks a bit nicer so I'm inclined to keep it, but I can remove this if you want - let me know




**Contributors**: Alex Bogdanov, Josh George, Carl Lebsack, Chris Morrow, Anees Shaikh, Rob Shakir

## Appendix - gRPC Authentication Flow Diagram
Expand Down