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

added doc for authorized_keys configuration #332

Merged
merged 12 commits into from
Apr 20, 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
37 changes: 37 additions & 0 deletions docs/authorized_keys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
id: authorized_keys
title: Authorized_Keys Configuration
---
# Signatory's Authorized Key Authentication Feature

Signatory provides the option to authenticate the octez-client, by specifying an "authorized key" in the Signatory configuration file.

## Motivation

An authorized key can be configured to ensure that Signatory only signs requests from an octez-client instance containing the private key.

## Configuration

First, a key pair is generated using octez-client:

```bash
octez-client gen keys signatory-auth
```

Next, find the public key value:

```bash
cat ~/.tezos-client/public_keys | grep -C 3 signatory-auth
```

Finally, add the public key value to the Signatory configuration file. It belongs within the `server` declaration:

```yaml
server:
address: :6732
utility_address: :9583
authorized_keys:
- edpkujLb5ZCZ2gprnRzE9aVHKZfx9A8EtWu2xxkwYSjBUJbesJ9rWE
```

Restarting the Signatory service is required to apply the configuration change. Henceforth, the Signatory service will only accept requests from the octez-client that is using the private key associated with the public key specified in the configuration file.
2 changes: 1 addition & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const sidebars = {
className: 'sidebarHeader',
collapsed: false,
collapsible: false,
items: ['start', 'file_based', 'yubihsm', 'azure_kms', 'gcp_kms', 'aws_kms', 'ledger', `cli`, 'remote_policy', 'bakers'],
items: ['start', 'file_based', 'yubihsm', 'azure_kms', 'gcp_kms', 'aws_kms', 'ledger', `cli`, 'remote_policy','authorized_keys', 'bakers'],
},
],
};
Expand Down