frostfs-s3-gw/docs/authmate.md

FrostFS S3 AuthMate

Authmate is a tool to create gateway AWS credentials. AWS users are authenticated with access key IDs and secrets, while FrostFS users are authenticated with key pairs. To complicate things further, we have S3 gateway that usually acts on behalf of some user, but the user doesn't necessarily want to give their keys to the gateway.

To solve this, we use FrostFS bearer tokens that are signed by the owner (FrostFS "user") and that can implement any kind of policy for FrostFS requests allowed to use this token. However, tokens can't be used as AWS credentials directly. Thus, they're stored on FrostFS as regular objects, and an access key ID is just an address of this object while a secret is generated randomly.

Tokens are not stored on FrostFS in plaintext, they're encrypted with a set of gateway keys. So, in order for a gateway to be able to successfully extract bearer token, the object needs to be stored in a container available for the gateway to read, and it needs to be encrypted with this gateway's key (among others potentially).

1. Generation of wallet
2. Issuance of a secret
   1. CLI parameters
   2. Bearer tokens
   3. Session tokens
   4. Containers policy
3. Obtainment of a secret
4. Generate presigned url
5. Update secrets
6. Exit codes

Generation of wallet

To generate a wallet for a gateway, run the following command:

$ ./neo-go wallet init -a -w wallet.json

Enter the name of the account > AccountTestName
Enter passphrase >
Confirm passphrase >

{
 	"version": "3.0",
 	"accounts": [
 		{
 			"address": "NhLQpDnerpviUWDF77j5qyjFgavCmasJ4p",
 			"key": "6PYUFyYpJ1JGyMrYV8NqeUFLKfpEVHsGGjCYtTDkjnKaSgYizRBZxVerte",
 			"label": "AccountTestName",
 			"contract": {
 				"script": "DCECXCsUZPwUyKHs6nAyyCvJ5s/vLwZkkVtWNC0zWzH8a9dBVuezJw==",
 				"parameters": [
 					{
 						"name": "parameter0",
 						"type": "Signature"
 					}
 				],
 				"deployed": false
 			},
 			"lock": false,
 			"isDefault": false
 		}
 	],
 	"scrypt": {
 		"n": 16384,
 		"r": 8,
 		"p": 8
 	},
 	"extra": {
 		"Tokens": null
 	}
 }

wallet is successfully created, the file location is wallet.json

To get the public key from the wallet:

$ ./bin/neo-go wallet dump-keys -w wallet.json

NhLQpDnerpviUWDF77j5qyjFgavCmasJ4p (simple signature contract):
025c2b1464fc14c8a1ecea7032c82bc9e6cfef2f0664915b56342d335b31fc6bd7

Issuance of a secret

To issue a secret means to create Bearer and, optionally, Session tokens and put them as an object into a container on the FrostFS network.

CLI parameters

Required parameters:

• --wallet is a path to a wallet .json file. You can provide a passphrase to decrypt a wallet via environment variable AUTHMATE_WALLET_PASSPHRASE, or you will be asked to enter a passphrase interactively. You can also specify an account address to use from a wallet using the --address parameter.
• --peer is an address of a FrostFS peer to connect to
• --gate-public-key is a public secp256r1 33-byte short key of a gate (use flags repeatedly for multiple gates). The tokens are encrypted by a set of gateway keys, so you need to pass them as well.

You can issue a secret using the parameters above only. The tool will

1. create a new container
   1. without a friendly name
   2. with ACL 0x3c8c8cce -- all operations are forbidden for OTHERS and BEARER user groups, except for GET
   3. with policy REP 2 IN X CBF 3 SELECT 2 FROM * AS X
2. put bearer and session tokens with default rules (details in Bearer tokens and Session tokens)

E.g.:

$ frostfs-s3-authmate issue-secret --wallet wallet.json \
 --peer 192.168.130.71:8080 \
 --gate-public-key 0313b1ac3a8076e155a7e797b24f0b650cccad5941ea59d7cfd51a024a8b2a06bf\
 --gate-public-key 0317585fa8274f7afdf1fc5f2a2e7bece549d5175c4e5182e37924f30229aef967

 Enter password for wallet.json >

{
  "access_key_id": "5g933dyLEkXbbAspouhPPTiyLZRg4axBW1axSPD87eVT0AiXsH4AjYy1iTJ4C1WExzjBrSobJsQFWEyKLREe5sQYM",
  "initial_access_key_id": "5g933dyLEkXbbAspouhPPTiyLZRg4axBW1axSPD87eVT0AiXsH4AjYy1iTJ4C1WExzjBrSobJsQFWEyKLREe5sQYM",
  "secret_access_key": "438bbd8243060e1e1c9dd4821756914a6e872ce29bf203b68f81b140ac91231c",
  "owner_private_key": "274fdd6e71fc6a6b8fe77bec500254115d66d6d17347d7db0880d2eb80afc72a",
  "container_id":"5g933dyLEkXbbAspouhPPTiyLZRg4axBW1axSPD87eVT"
}

access_key_id and secret_access_key are AWS credentials that you can use with any S3 client.

initial_access_key_id contains the first credentials in the chain of credentials versions (can be useful when you update your credentials).

access_key_id consists of Base58 encoded containerID(cid) and objectID(oid) stored on the FrostFS network and containing the secret. Format of access_key_id: %cid0%oid, where 0(zero) is a delimiter.

Optional parameters:

• --container-id - you can put the tokens into an existing container, but this way is not recommended.
• --container-friendly-name -- name of a container with tokens, by default container will not have a friendly name
• --container-placement-policy - placement policy of auth container to put the secret into. Default value is REP 2 IN X CBF 3 SELECT 2 FROM * AS X
• --lifetime-- lifetime of tokens. For example 50h30m (note: max time unit is an hour so to set a day you should use 24h). Default value is 720h (30 days). It will be ceil rounded to the nearest amount of epoch
• --aws-cli-credentials - path to the aws cli credentials file, where authmate will write access_key_id and secret_access_key to
• --rpc-endpoint - NEO node RPC address (must be provided if --container-id is NNS name)
• --access-key-id - access key id of s3 credential that must be created (must be unique)
• --secret-access-key - secret access key of s3 credential that must be used

You also can specify AccessKeyID/SecretAccessKey pair that should be created:

$ frostfs-s3-authmate issue-secret --wallet wallet.json \
--peer 192.168.130.71:8080 \
 --gate-public-key 0313b1ac3a8076e155a7e797b24f0b650cccad5941ea59d7cfd51a024a8b2a06bf \
 --gate-public-key 0317585fa8274f7afdf1fc5f2a2e7bece549d5175c4e5182e37924f30229aef967 \
 --access-key-id my-access-key \
 --secret-access-key my-secret-key \
 --container-id BpExV76416Vo7GrkJsGwXGoLM35xsBwup8voedDZR3c6

 Enter password for wallet.json >

{
  "initial_access_key_id": "my-access-key-3",
  "access_key_id": "my-access-key",
  "secret_access_key": "my-secret-key",
  "owner_private_key": "d9972cc4f21b07a90f4b347c72c33c1d1611c2b9a2cfd0cc28cee8cb221e8e55",
  "wallet_public_key": "031a6c6fbbdf02ca351745fa86b9ba5a9452d785ac4f7fc2b7548ca2a46c4fcf4a",
  "container_id": "BpExV76416Vo7GrkJsGwXGoLM35xsBwup8voedDZR3c6"
}

Bearer tokens

Creation of bearer tokens is mandatory.

Bearer token will be created with impersonate flag. It means that gate (which will use such token to interact with node) can have access to your private containers or to containers in which eACL grants access to you by public key.

Session tokens

With a session token, there are 3 options:

1. append --session-tokens parameter with your custom rules in json format (as a string or file path). E.g.:

   $ frostfs-s3-authmate issue-secret --wallet wallet.json \
   --peer 192.168.130.71:8080 \
   --gate-public-key 0313b1ac3a8076e155a7e797b24f0b650cccad5941ea59d7cfd51a024a8b2a06bf \
   --session-tokens session.json
   

   where content of session.json:

   [
     {
       "verb": "PUT",
       "containerID": null
     },
     {
       "verb": "DELETE",
       "containerID": null
     }
   ]
   

   Available verb values: PUT, DELETE.

   If containerID is null or omitted, then session token rule will be applied to all containers. Otherwise, specify containerID value in human-readable format (base58 encoded string).

   NB! To create buckets in FrostFS it's necessary to have session tokens with PUT permissions.

2. append --session-tokens parameter with the value none -- no session token will be created

3. skip the parameter, and authmate will create session tokens with default rules (the same as in session.json in example above)

Containers policy

Rules for mapping of LocationConstraint (aws spec) to PlacementPolicy can be set via parameter --container-policy (json-string and file path allowed):

{
  "rep-3": "REP 3",
  "complex": "REP 1 IN X CBF 1 SELECT 1 FROM * AS X",
  "example-json-policy": "{\"replicas\":[{\"count\":3,\"selector\":\"SelASD0\"}],\"container_backup_factor\":3,\"selectors\":[{\"name\":\"SelASD0\",\"count\":3,\"filter\":\"*\"}],\"filters\":[]}"
}

User registration

To be able to interact with FrostFS Storage using s3-gw the user (whose credential is used) must be registered in frostfsid contract and also must have allowed chain rules in policy contract.

CLI parameters

Required parameters:

• --wallet is a path to a wallet .json file. You can provide a passphrase to decrypt a wallet via environment variable AUTHMATE_WALLET_PASSPHRASE, or you will be asked to enter a passphrase interactively. You can also specify an account address to use from a wallet using the --address parameter. Key from this wallet will be registered in frostfsid contract and for this key allowed rules will be added.
• --rpc-endpoint -- NEO node RPC address.

Optional parameters:

• --frostfsid-contract -- FrostfsID contract hash (LE) or name in NNS to register public key in contract ( default: frostfsid.frostfs).
• --username -- Username to set for public key in frostfsid contract.
• --namespace -- Namespace to register public key in frostfsid contract and add allowed rules (default: "").
• --contract-wallet -- is a path to a contract wallet .json file. This wallet will be used to sign transactions (if missing key from wallet flag be used). You can provide a passphrase to decrypt a wallet via environment variable AUTHMATE_WALLET_CONTRACT_PASSPHRASE, or you will be asked to enter a passphrase interactively. You can also specify an account address to use from a wallet using the --contract-wallet-address parameter.
• --policy-contract -- Policy contract hash (LE) or name in NNS to save allowed chains for key ( default: policy.frostfs).
• --proxy-contract -- Proxy contract hash (LE) or name in NNS to use when interact with frostfsid contract ( default: proxy.frostfs).

Example command that not only create access keys for key, but also register key in frostfsid contract and create allowed rules in policy contract:

$ frostfs-s3-authmate register-user --wallet subject-wallet.json \
  --contract-wallet wallet-registered-in-proxy-contract.json \
  --frostfsid-contract frostfsid.frostfs \
  --namespace "" \
  --usrername devenv \
  --proxy-contract proxy.frostfs \
  --policy-contract policy.frostfs \
  --rpc-endpoint http://morph-chain.frostfs.devenv:30333

Added policy rules:
kind: 'u'
entity: ':NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM'
chains:
[{"ID":"czM6YXV0aG1hdGU=","Rules":[{"Status":"Allow","Actions":{"Inverted":false,"Names":["*"]},"Resources":{"Inverted":false,"Names":["*"]},"Any":false,"Condition":null}],"MatchType":"DenyPriority"},{"ID":"aW5ncmVzczphdXRobWF0ZQ==","Rules":[{"Status":"Allow","Actions":{"Inverted":false,"Names":["*"]},"Resources":{"Inverted":false,"Names":["*"]},"Any":false,"Condition":null}],"MatchType":"DenyPriority"}]

Obtaining credential secrets

You can get a secret access key and bearer token associated with an access key ID by obtaining a secret stored on the FrostFS network. Here is an example of providing one password (for wallet.json) via env variable and the other (for gate-wallet.json) interactively:

$ AUTHMATE_WALLET_PASSPHRASE=some-pwd \
frostfs-s3-authmate obtain-secret --wallet wallet.json \
--peer 192.168.130.71:8080 \
--gate-wallet gate-wallet.json \
--access-key-id 5g933dyLEkXbbAspouhPPTiyLZRg4axBW1axSPD87eVT0AiXsH4AjYy1iTJ4C1WExzjBrSobJsQFWEyKLREe5sQYM

Enter password for gate-wallet.json >
{
  "bearer_token": {
    "body": {
      "eaclTable": null,
      "ownerID": {
        "value": "Naq5pfYuroaGE7h9o5iQsPR/1aRe5gmWrg=="
      },
      "lifetime": {
        "exp": "10813",
        "nbf": "13",
        "iat": "13"
      },
      "allowImpersonate": true
    },
    "signature": {
      "key": "Axpsb7vfAso1F0X6hrm6WpRS14WsT3/Ct1SMoqRsT89K",
      "signature": "BMIOqcNEwTughI26ivFw7vnGyzhWip8NsgSYTTf21aVkv0AH7bgE9R91gglYgS6tGNVcWZMTisYCJCT3OEQ9lkw=",
      "scheme": "ECDSA_SHA512"
    }
  },
  "secret_access_key": "438bbd8243060e1e1c9dd4821756914a6e872ce29bf203b68f81b140ac91231c"
}

Generate presigned URL

You can generate presigned url using AWS credentials from ~/.aws/credentials (you can specify profile using the --profile flag) with the following command:

$ frostfs-s3-authmate generate-presigned-url --endpoint http://localhost:8084 \
  --method get --bucket presigned --object obj --lifetime 30s

{
  "URL": "http://localhost:8084/presigned/obj?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=6UpmiuYspPLMWfyhEKYmZQSsTGkFLS5MhQVdsda3fhz908Hw9eo9urTmaJtfvHMHUpY8SWAptk61bns2Js8f1M5tZ%2F20220615%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20220615T084203Z&X-Amz-Expires=30&X-Amz-SignedHeaders=host&X-Amz-Signature=47f74d4b84566708a17dded05cce732690745f141235215104ad051e265e3c59"
}

You can also provide credential explicitly:

$ frostfs-s3-authmate generate-presigned-url --endpoint http://localhost:8084 \
  --method put --bucket presigned --object obj --lifetime 12h \
  --region ru --aws-secret-access-key c2d65ef2980f03f4f495bdebedeeae760496697880d61d106bb9a4e5cd2e0607 \
  --aws-access-key-id ETaA2CadPcA7bAkLsML2PbTudXY8uRt2PDjCCwkvRv9s0FDCxWDXYc1SA1vKv8KbyCNsLY2AmAjJ92Vz5rgvsFCy

{
  "URL": "http://localhost:8084/presigned/obj?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ETaA2CadPcA7bAkLsML2PbTudXY8uRt2PDjCCwkvRv9s0FDCxWDXYc1SA1vKv8KbyCNsLY2AmAjJ92Vz5rgvsFCy%2F20220615%2Fru%2Fs3%2Faws4_request&X-Amz-Date=20220615T084455Z&X-Amz-Expires=43200&X-Amz-SignedHeaders=host&X-Amz-Signature=ac92aecc3787eeed03922ea82af082091c806f1bb58a7101602ed21369815d04"
}

Upload file with presigned URL

1. Generate presigned URL to upload object obj to bucket presigned

   $ frostfs-s3-authmate generate-presigned-url --endpoint http://localhost:8084 \
   --method put --bucket presigned --object obj --lifetime 30s
   
   {
     "URL": "http://localhost:8084/presigned/obj?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=CYfbvKwSC9VNvttj5snyEZ5Ttr2VaBabpw7mRuEzNXyw09ewUERj6MGDKfyckfg5VZ39GfXbwLwz62UPVeRxhJDet%2F20241029%2Fdefault%2Fs3%2Faws4_request&X-Amz-Date=20241029T145726Z&X-Amz-Expires=30&X-Amz-SignedHeaders=host&X-Amz-Signature=2bb13b3e6448968219ad95147debe49e37bce5ce3ed1344c4015f43cb444a956"
   }
   

2. Upload file using curl

   curl --upload-file /path/to/file 'http://localhost:8084/presigned/obj?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=CYfbvKwSC9VNvttj5snyEZ5Ttr2VaBabpw7mRuEzNXyw09ewUERj6MGDKfyckfg5VZ39GfXbwLwz62UPVeRxhJDet%2F20241029%2Fdefault%2Fs3%2Faws4_request&X-Amz-Date=20241029T145726Z&X-Amz-Expires=30&X-Amz-SignedHeaders=host&X-Amz-Signature=2bb13b3e6448968219ad95147debe49e37bce5ce3ed1344c4015f43cb444a956'
   

AWS CLI

You can also can get the presigned URL (only for GET) using aws cli v2:

$ aws s3 --endpoint http://localhost:8084 presign s3://pregigned/obj

http://localhost:8084/pregigned/obj?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=6UpmiuYspPLMWfyhEKYmZQSsTGkFLS5MhQVdsda3fhz908Hw9eo9urTmaJtfvHMHUpY8SWAptk61bns2Js8f1M5tZ%2F20220615%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20220615T072348Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=b82c13952534b1bba699a718f2d42d135c2833a1e64030d4ce0e198af46551d4

Update secret

You can extend list of s3 gates that can accept already issued credentials. To do this use frostfs-s3-authmate update-secret command:

Required parameters:

• --wallet is a path to a user wallet .json file. You can provide a passphrase to decrypt a wallet via environment variable AUTHMATE_WALLET_PASSPHRASE, or you will be asked to enter a passphrase interactively. You can also specify an account address to use from a wallet using the --address parameter.
• --gate-wallet is a path to a gate wallet .json file (need to decrypt current access box version). You can provide a passphrase to decrypt a wallet via environment variable AUTHMATE_WALLET_GATE_PASSPHRASE, or you will be asked to enter a passphrase interactively. You can also specify an account address to use from a wallet using the --gate-address parameter.
• --peer is an address of a FrostFS peer to connect to
• --gate-public-key is a public secp256r1 33-byte short key of a gate (use flags repeatedly for multiple gates).
• --access-key-id is a credential id to update.

$ frostfs-s3-authmate update-secret --wallet wallet.json --gate-wallet s3-wallet.json \
 --peer 192.168.130.71:8080 \
 --gate-public-key 0313b1ac3a8076e155a7e797b24f0b650cccad5941ea59d7cfd51a024a8b2a06bf \
 --gate-public-key 0317585fa8274f7afdf1fc5f2a2e7bece549d5175c4e5182e37924f30229aef967 \
 --gate-public-key 0223450b9db6d0c083e9c6de1f7d8fd22858d70829e09afa39828bb2416bf190fc \
 --access-key-id HwrdXgetdGcEWAQwi68r1PMvw4iSm1Y5Z1fsFNSD6sQP04QomYDfYsspMhENEDhzTGwGxm86Q6R2Weugf3PG4sJ3M

Enter password for wallet.json >
Enter password for s3-wallet.json >

{
  "initial_access_key_id": "HwrdXgetdGcEWAQwi68r1PMvw4iSm1Y5Z1fsFNSD6sQP04QomYDfYsspMhENEDhzTGwGxm86Q6R2Weugf3PG4sJ3M",
  "access_key_id": "HwrdXgetdGcEWAQwi68r1PMvw4iSm1Y5Z1fsFNSD6sQP0xXf1ahGndNkydG9MrL9WmCebrPwdSHTAysQa9w6yCNJ",
  "secret_access_key": "f6a65481fd2752e69e4aa80a6fdcad70cfbf8304d2b3b8c2f9c15212aeee3ae7",
  "owner_private_key": "7f40233893e4f4a54e4f2f52455a0e6d563f7eb0233a985094937ed69faef681",
  "wallet_public_key": "031a6c6fbbdf02ca351745fa86b9ba5a9452d785ac4f7fc2b7548ca2a46c4fcf4a",
  "container_id": "HwrdXgetdGcEWAQwi68r1PMvw4iSm1Y5Z1fsFNSD6sQP"
}

Exit codes

There are several non-zero exit codes added at the moment.

Code	Description
1	Any unknown errors, or errors generated by the parser of command line parameters.
2	Preparation errors: malformed configuration, issues with input data parsing.
3	FrostFS errors: connectivity problems, misconfiguration.
4	Business logic errors: authmate could not execute its task because of some restrictions.