In Depth JWT Guide
This document provides a step by step deep dive into JWT usage within NATS. Starting with related concepts, it will introduce JWTs and how they can be used in NATS. This will NOT list every JWT/nsc option, but will focus on the important options and concepts.
To exercise listed examples please have the following installed:
To installnats-server,nats,nk,nsc:export GO111MODULE=ongo install github.com/nats-io/nats-server/[email protected]go install github.com/nats-io/natscli/[email protected]go install github.com/nats-io/nkeys/[email protected]go install github.com/nats-io/nsc/[email protected]To practice the examples below:Save the configuration below in a file named sayserver.conf, and start nats server via:nats-server -c server.confSo that the server started. Later when we change the configuration we can do a reload like this:nats-server --signal reload
Accounts are the NATS isolation context.
accounts: {
A: {
users: [{user: a, password: a}]
},
B: {
users: [{user: b, password: b}]
},
}
Messages published in one account won't be received in another.
Listen for any message on account
a:nats -s nats://a:[email protected]:4222 sub ">"
Publish a message from account
b:nats -s nats://b:[email protected]:4222 pub "foo" "user b"
Note that you do not see this message received by your subscriber.
Now publish a messages from account
a:nats -s nats://a:[email protected]:4222 pub "foo" "user a"
This time the message is received by the subscriber:
17:57:06 [#1] Received on "foo"
user a
The above example shows no message flow between user
a associated with account A and user b in account B. Messages are delivered only within the same account. That is, unless you explicitly define it.Below is a similar example, this time with messages crossing explicit account boundaries.
accounts: {
A: {
users: [{user: a, password: a}]
imports: [{stream: {account: B, subject: "foo"}}]
},
B: {
users: [{user: b, password: b}]
exports: [{stream: "foo"}]
},
}
Modifyserver.confand runnats-server --signal reload
Subscribe to everything as user 'a'
nats -s nats://a:[email protected]:4222 sub ">"
Publish on 'foo' as user 'b':
nats -s nats://b:[email protected]:4222 pub "foo" "user b"
This time the message is received by the subscriber:
18:28:25 [#1] Received on "foo"
user b
Accounts are a lot more powerful than what has been demonstrated here. Take a look at the complete documentation of accounts and the users associated with them. All of this is in a plain NATS config file. (Copy the above config and try it using this command:
nats-server -c <filename>) In order to make any changes, every participating nats-server config file in the same security domain has to change. This configuration is typically controlled by one organization or the administrator.- Accounts are isolated from each other.
- One can selectively combine accounts,
- Need to modify a config file to add/remove/modify accounts and users,
- The config file can be applied to take effect via
nats-server --signal reload.
Ed25519 is:
- a public key signature system. (can sign and verify signatures)
- resistant to side channel attacks (no conditional jumps in algorithm)
NATS server can be configured with public NKEYs as user (identities). When a client connects the nats-server sends a challenge for the client to sign in order to prove it is in possession of the corresponding private key. The nats-server then verifies the signed challenge. Unlike with a password based scheme, the secret never left the client.
To assist with knowing what type of key one is looking at, in config or logs, the keys are decorated as follows:
- Public Keys, have a one byte prefix:
O,A,Ufor various types,Ofor operator,Afor account, andUmeaning user. - Private Keys, have a two byte prefix
SO,SA,SU.Sstands for seed. The remainders(O,AandU) are the same meaning as in public keys.
NKEYs are generated as follows:
nk -gen user -pubout > a.nk
To view the key:
cat a.nk
SUAAEZYNLTEA2MDTG7L5X7QODZXYHPOI2LT2KH5I4GD6YVP24SE766EGPA
UC435ZYS52HF72E2VMQF4GO6CUJOCHDUUPEBU7XDXW5AQLIC6JZ46PO5
Create another key:
nk -gen user -pubout > b.nk
View the key:
cat b.nk
SUANS4XLL5NWBTM57GSVHLN4TMFW55WGGWNI5YXXSIOYFJQYFVNHJK5GFY
UARZVI6JAV7YMJTPRANXANOOW4K3ZCD45NYP6S7C7XKCBHPVN2TFZ7ZC
Replacing the user/password with NKEY in account config example:
accounts: {
A: {
users: [{nkey:UC435ZYS52HF72E2VMQF4GO6CUJOCHDUUPEBU7XDXW5AQLIC6JZ46PO5}]
imports: [{stream: {account: B, subject: "foo"}}]
},
B: {
users: [{nkey:UARZVI6JAV7YMJTPRANXANOOW4K3ZCD45NYP6S7C7XKCBHPVN2TFZ7ZC}]
exports: [{stream: "foo"}]
},
}
Simple example:
Subscribe with
nats -s nats://localhost:4222 sub --nkey=a.nk ">"Publish a message using
nats -s nats://localhost:4222 pub --nkey=b.nk foo nkey the subscriber should receive it.When the nats-server was started with
-V tracing, you can see the signature in the CONNECT message (formatting added manually):[95184] 2020/10/26 12:15:44.350577 [TRC] [::1]:55551 - cid:2 - <<- [CONNECT {
"echo": true,
"headers": true,
"lang": "go",
"name": "NATS CLI",
"nkey": "UC435ZYS52HF72E2VMQF4GO6CUJOCHDUUPEBU7XDXW5AQLIC6JZ46PO5",
"no_responders": true,
"pedantic": false,
"protocol": 1,
"sig": "lopzgs98JBQYyRdw1zT_BoBpSFRDCfTvT4le5MYSKrt0IqGWZ2OXhPW1J_zo2_sBod8XaWgQc9oWohWBN0NdDg",
"tls_required": false,
"verbose": false,
"version": "1.11.0"
}]
On connect, clients are instantly sent the nonce to sign as part of the
INFO message (formatting added manually). Since telnet will not authenticate, the server closes the connection after hitting the authorization timeout.> telnet localhost 4222
Trying ::1...
Connected to localhost.
Escape character is '^]'.
INFO {
"auth_required": true,
"client_id": 3,
"client_ip": "::1",
"go": "go1.14.1",
"headers": true,
"host": "0.0.0.0",
"max_payload": 1048576,
"nonce": "-QPTE1Jsk8kI3rE",
"port": 4222,
"proto": 1,
"server_id": "NBSHIXACRHUODC4FY2Z3OYXSZSRUBRH6VWIKQNGVPKOTA7H4YTXWJRTO",
"server_name": "NBSHIXACRHUODC4FY2Z3OYXSZSRUBRH6VWIKQNGVPKOTA7H4YTXWJRTO",
"version": "2.2.0-beta.26"
}
-ERR 'Authentication Timeout'
Connection closed by foreign host.
- NKEYS are a secure way to authenticate clients,
- Private keys are never accessed or stored by the NATS server,
- The public key still needs to be configured in NATS server.
In a large organization the centralized configuration approach can lead to less flexibility and more resistance to change when controlled by one entity. Alternatively, instead of operating one infrastructure, it can be deployed more often (say per team) thus making import/export relationships harder as they have to bridge separate systems. In order to make accounts truly powerful, they should ideally be configured separately from the infrastructure, only constrained by limits. This is similar for user. An account contains the user but this relationship could be a reference as well, such that alterations to user do not alter the account. Users of the same account should be able to connect from anywhere in the same infrastructure and be able to exchange messages as long as they are in the same authentication domain.
- JWT splits a nats-server configuration into separate artifacts manageable by different entities.
- Management of Accounts, Configuration, and Users are separated.
- Accounts do NOT correspond to infrastructure, they correspond to teams or applications.
- Connect to any cluster in the same infrastructure and be able to communicate with all other users in your account.
- Infrastructure and its topology have nothing to do with Accounts and where an Account's User connects from.
Account and User creation managed as separate artifacts in a decentralized fashion using NKEYs. Relying upon a hierarchical chain of trust between three distinct NKEYs and associated roles:
- 1.Operator: corresponds to operator of a set of NATS servers in the same authentication domain (entire topology, crossing gateways and leaf nodes),
- 2.Account: corresponds to the set of a single account's configuration,
- 3.User: corresponds to one user's configuration.
Each NKEY is referenced, together with additional configuration, in a JWT document. Each JWT has a subject field and its value is the public portion of an NKEY and serves as identity. Names exist in JWT but as of now are only used by tooling,
nats-server does not read this value. The referenced NKEY's role determines the JWT content:- 1.
- 2.Account JWTs contain Account specific configuration such as exports, imports, limits, and default user permissions,
- 3.
In addition, JWTs can contain settings related to their decentralized nature, such as expiration/revocation/signing. At no point do JWTs contain the private portion of an NKEY, only signatures that can be verified with public NKEY. JWT content can be viewed as public, although it's content may reveal which subjects/limits/permissions exist.
- JWTs are hierarchically organized in operator, account and user,
- They carry corresponding configuration and the configuration has been dedicated to the decentralized nature of NATS JWT usage.
A
nats-server is configured to trust an operator. Meaning, the Operator JWT is part of its server configuration and requires a restart or nats-server --signal reload once the configuration changed. It is also configured with a way to obtain account JWT in one of three ways (explained below).Clients provide a User JWT when connecting. An Account JWT is not used by clients talking to a
nats-server. The clients also possess the private NKEY corresponding to the JWT identity, so that they can prove their identity as described above.The issuer field of the User JWT identifies the Account, and the
nats-server then independently obtains the current Account JWT from its configured source. The server can then verify that signature on the User JWT was issued by an NKEY of the claimed Account, and in turn that the Account has an issuer of the Operator and that an NKEY of the Operator signed the Account JWT. The entire three-level hierarchy is verified.To obtain an Account JWT, the nats-server is configured with one of three resolver types. Which one to pick depends upon your needs:
- You are comfortable changing the server config if the operator or any accounts changed,
- You can generate a user programmatically using NKEYs and a JWT library (more about that later),
- Users do not need to be known by nats-server.
- Same as
mem-resolver, except you do not need to modify the server configurations when accounts are added or changed, - Changes to the operator still require a server reloading (only a few operations require that),
- Will download Accounts from a web server
- Allows for easy publication of account JWTs programmatically generated using NKEYs and the JWT library.
- The
nats-account-serveris such a webserver. When set up correctly, it will informnats-serverof Account JWT changes.
- Depending on configuration, requires read and/or write access to persistent storage.
nats-resolver: Same asurl-resolver, just uses NATS instead of http- No separate binary to run/config/monitor,
- Easier clustering when compared to
nats-account-server. Will eventually converge on the union of all account JWTs known to every participatingnats-server, - Requires persistent storage in the form of a directory for
nats-serverto exclusively write to (it can be on a shared Network File System, but the directories themselves can not be shared between servers), - Optionally, directly supports Account JWT removal,
- Between
nats-resolverandurl-resolver, thenats-resolveris the clear recommendation.
JWT
nats-resolver is recommended to use in production environment. With JWT nats-resolver, you can manage huge accounts and users without server reloading. But before adopting JWT nat-resolver, make sure you understand correctly how it works. You can make use of static account settings(probably with NKEYs) and memory-resolver as the necessary steps forwarding JWT nats-resolver fully understanding.Each JWT document has a subject(
sub) it represents. This is the public identity NKEY represented by the JWT document. JWT documents contain an issued at (iat) time of signing. This time is in seconds since Unix epoch. It is also used to determine which of two JWTs for the same subject is more recent. Furthermore JWT documents have an issuer, this may be an (identity) NKEY or a dedicated signing NKEY of an item one level above it in the trust hierarchy. A key is a signing key if it is listed as such in the JWT (above). Signing NKEYs adhere to same NKEY roles and are additional keys that unlike identity NKEY may change over time. In the hierarchy, signing keys can only be used to sign JWT for the role right below them. User JWTs have no signing keys for this reason. To modify one role's set of signing keys, the identity NKEY needs to be used.Each JWT is signed as below:
jwt.sig = sign(hash(jwt.header + jwt.body), private-key(jwt.issuer))
(jwt.issuer is part of jwt.body)
If a JWT is valid, the JWT above it is validated as well. If all of them are valid, the chain of trust between them is tested top down as follows:
Type | Trust Rule | Obtained |
|---|---|---|
Operator | jwt.issuer == jwt.subject (self signed) | configured to trust |
Account | jwt.issuer == trusted issuing operator (signing/identity) key | configured to obtain |
User | jwt.issuer == trusted issuing account (signing/identity) key && jwt.issuedAt > issuing account revocations[jwt.subject] | provided on connect |
This is a conceptual view. While all these checks happen, the results of earlier evaluations might be cached: if the Operator/Account is trusted already and the JWT did not change since, then there is no reason to re-evaluate.
Below are examples of decoded JWT (
iss == issuer, sub == subject, iat == issuedAt):nsc describe operator --json
{
"iat": 1603473819,
"iss": "OBU5O5FJ324UDPRBIVRGF7CNEOHGLPS7EYPBTVQZKSBHIIZIB6HD66JF",
"jti": "57BWRLW67I6JTVYMQAZQF54G2G37DJB5WG5IFIPVYI4PEYNX57ZQ",
"name": "DEMO",
"nats": {
"account_server_url": "nats://localhost:4222",
"system_account": "AAAXAUVSGK7TCRHFIRAS4SYXVJ76EWDMNXZM6ARFGXP7BASNDGLKU7A5"
},
"sub": "OBU5O5FJ324UDPRBIVRGF7CNEOHGLPS7EYPBTVQZKSBHIIZIB6HD66JF",
"type": "operator"
}
nsc describe account -n demo-test --json:{
"iat": 1603474600,
"iss": "OBU5O5FJ324UDPRBIVRGF7CNEOHGLPS7EYPBTVQZKSBHIIZIB6HD66JF",
"jti": "CZDE4PM7MGFNYHRZSE6INTP6QDU4DSLACVHPQFA7XEYNJT6R6LLQ",
"name": "demo-test",
"nats": {
"limits": {
"conn": -1,
"data": -1,
"exports": -1,
"imports": -1,
"leaf": -1,
"payload": -1,
"subs": -1,
"wildcards": true
}
},
"sub": "ADKGAJU55CHYOIF5H432K2Z2ME3NPSJ5S3VY5Q42Q3OTYOCYRRG7WOWV",
"type": "account"
}
nsc describe user -a demo-test -n alpha --json:{
"iat": 1603475001,
"iss": "ADKGAJU55CHYOIF5H432K2Z2ME3NPSJ5S3VY5Q42Q3OTYOCYRRG7WOWV",
"jti": "GOOPXCFDWVMEU3U6I6MT344Z56MGBYIS42GDXMUXDFA3NYDR2RUQ",
"name": "alpha",
"nats": {
"pub": {},
"sub": {}
},
"sub": "UC56LV5NNMP5FURQZ7HZTGWCRRTWSMHZNNELQMHDLH3DCYNGX57B2TN6",
"type": "user"
}
>
When a client connects, the steps below have to succeed. The following nats-server configuration is used (for ease of understanding, we are using url-resolver):
operator: ./trustedOperator.jwt
resolver: URL(http://localhost:9090/jwt/v1/accouts/)
- 1.> telnet localhost 4222Trying 127.0.0.1...Connected to localhost.Escape character is '^]'.INFO {"auth_required": true,"client_id": 5,"client_ip": "127.0.0.1","go": "go1.14.1","headers": true,"host": "localhost","max_payload": 1048576,"nonce": "aN9-ZtS7taDoAZk","port": 4222,"proto": 1,"server_id": "NCIK6FX5MRIEPMEK22YL2ECLIWVJBH2SWFD5EQWSI5XRDQPKZXWKX3VP","server_name": "NCIK6FX5MRIEPMEK22YL2ECLIWVJBH2SWFD5EQWSI5XRDQPKZXWKX3VP","tls_required": true,"version": "2.2.0-beta.26"}Connection closed by foreign host.For ease of use, the NATS CLI uses a creds file that is the concatenation of JWT and private user identity/NKEY.> cat user.creds-----BEGIN NATS USER JWT-----eyJ0eXAiOiJqd3QiLCJhbGciOiJlZDI1NTE5In0.eyJqdGkiOiJXNkFYSFlSS1RHVTNFUklQM0dSRDdNV0FQTzQ2VzQ2Vzc3R1JNMk5SWFFIQ0VRQ0tCRjJRIiwiaWF0IjoxNjAzNDczNzg4LCJpc3MiOiJBQUFYQVVWU0dLN1RDUkhGSVJBUzRTWVhWSjc2RVdETU5YWk02QVJGR1hQN0JBU05ER0xLVTdBNSIsIm5hbWUiOiJzeXMiLCJzdWIiOiJVRE5ZMktLUFRJQVBQTk9OT0xBVE5SWlBHTVBMTkZXSFFQS1VYSjZBMllUQTQ3Tk41Vk5GSU80NSIsInR5cGUiOiJ1c2VyIiwibmF0cyI6eyJwdWIiOnt9LCJzdWIiOnt9fX0.ae3OvcapjQgbXhI2QbgIs32AWr3iBb2UFRZbXzIg0duFHNPQI5LsprR0OQoSlc2tic6e3sn8YM5x0Rt34FryDA------END NATS USER JWT------************************* IMPORTANT *************************NKEY Seed printed below can be used to sign and prove identity.NKEYs are sensitive and should be treated as secrets.-----BEGIN USER NKEY SEED-----SUAAZU5G7UOUR7VXQ7DBD5RQTBW54O2COGSXAVIYWVZE4GCZ5C7OCZ5JLY------END USER NKEY SEED------*************************************************************> nats -s localhost:4222 "--creds=user.creds" pub "foo" "hello world"
- 2.The Client responds with a
CONNECTmessage (formatting added manually), containing a JWT and signed nonce. (output copied fromnats-serverstarted with-V)[98019] 2020/10/26 16:07:53.861612 [TRC] 127.0.0.1:56830 - cid:4 - <<- [CONNECT {"echo": true,"headers": true,"jwt": "eyJ0eXAiOiJqd3QiLCJhbGciOiJlZDI1NTE5In0.eyJqdGkiOiJXNkFYSFlSS1RHVTNFUklQM0dSRDdNV0FQTzQ2VzQ2Vzc3R1JNMk5SWFFIQ0VRQ0tCRjJRIiwiaWF0IjoxNjAzNDczNzg4LCJpc3MiOiJBQUFYQVVWU0dLN1RDUkhGSVJBUzRTWVhWSjc2RVdETU5YWk02QVJGR1hQN0JBU05ER0xLVTdBNSIsIm5hbWUiOiJzeXMiLCJzdWIiOiJVRE5ZMktLUFRJQVBQTk9OT0xBVE5SWlBHTVBMTkZXSFFQS1VYSjZBMllUQTQ3Tk41Vk5GSU80NSIsInR5cGUiOiJ1c2VyIiwibmF0cyI6eyJwdWIiOnt9LCJzdWIiOnt9fX0.ae3OvcapjQgbXhI2QbgIs32AWr3iBb2UFRZbXzIg0duFHNPQI5LsprR0OQoSlc2tic6e3sn8YM5x0Rt34FryDA","lang": "go","name": "NATS CLI","no_responders": true,"pedantic": false,"protocol": 1,"sig": "VirwM--xq5i2RI9VEQiFYv_6JBs-IR4oObypglR7qVxYtXDUtIKIr1qXW_M54iHFB6Afu698J_in5CfBRjuVBg","tls_required": true,"verbose": false,"version": "1.11.0"}] - 3.Server verifies if a JWT returned is a user JWT and if it is consistent:
sign(jwt.sig, jwt.issuer) == hash(jwt.header+jwt.body)(issuer is part of body), - 4.Server verifies if nonce matches JWT.subject, thus proving client's possession of private user NKEY,
- 5.Server either knows referenced account or downloads it from
http://localhost:9090/jwt/v1/accouts/AAAXAUVSGK7TCRHFIRAS4SYXVJ76EWDMNXZM6ARFGXP7BASNDGLKU7A5, - 6.Server verifies downloaded JWT is an account JWT and if it is consistent:
sign(jwt.sig, jwt.issuer) == hash(jwt.header+jwt.body)(issuer is part of body), - 7.Server verifies if an account JWT issuer is in configured list of trusted operator keys (derived from operator JWT in configuration),
- 8.Server verifies that a user JWT subject is not in the account's revoked list, or if jwt.issuedAt field has a higher value,
- 9.Server verifies that a user JWT issuer is either identical to the account JWT subject or part of the account JWT signing keys,
- 10.If all of the above holds true, the above invocation will succeed, only if the user JWT does not contain permissions or limits restricting the operation otherwise> nats -s localhost:4222 "--creds=user.creds" pub "foo" "hello world"> 16:56:02 Published 11 bytes to "foo"
- 11.Output if
user.credswere to contain a JWT where the maximum message payload is limited to 5 bytes> nats -s localhost:4222 "--creds=user.creds" pub "foo" "hello world"nats: error: nats: Maximum Payload Violation, try --help>
- JWTs are secure,
- JWTs carry configuration appropriate to their role as Operator/Accounts/User,
- JWTs provide a basis for operating one single NATS infrastructure which serves separate, yet optionally connected, entities,
- Account resolvers are a way to obtain unknown Account JWTs,
- On connect clients provide only the User JWT and use the NKEY for the JWT to authenticate,
- JWTs can be issued programmatically.
Depending on which entity has access to private Operator/Account identity or signing NKEYs, different deployment models are enabled. When picking one, it is important to pick the simplest deployment model that enables what you need it to do. Everything beyond just results in unnecessary configuration and steps.
- 1.Centralized config: one (set of) user(s) has access to all private operator and account NKEYs,Administrators operating the shared infrastructure call all the shots
- 2.Decentralized config (with multiple
nscenvironments, explained later):- 1.Administrator/Operator(s) have access to private operator NKEYs to sign accounts. By signing or not signing an account JWT, Administrators can enforce constraints (such as limits).
- 2.Other sets of users (teams) have access to their respective private account identity/signing NKEYs and can issue/sign a user JWT.
This can also be used by a single entity to not mix up nsc environments as well. - 3.Self-service, decentralized config (shared dev cluster):Is similar to 2, but sets of users in 2.1 have access to an operator private signing NKEY.This allows teams to add/modify their own accounts.Since administrators give up control over limits, there should be at least one organizational mechanism to prevent unchecked usage.Administrators operating the infrastructure can add/revoke access by controlling the set of operator signing keys.
- 4.Mix of the above - as needed: separate sets of users (with multiple
nscenvironments).For some user/teams the Administrator operates everything.
- Account signing key enabled on the fly:
- user generation (explained later),
- export activation generation (explained later).
- Operator signing key enables on the fly account generation.
- JWTs and the associated chain of trust allows for centralized, decentralized, or self-service account configuration,
- It is important to pick the deployment model that fits your needs, NOT the most complicated one,
- Distributing Operator/Account JWT NKEYs between Administrators and teams enables these deployment models,
- Sign-up services for Accounts/Users can be implemented by programs in possession of the parent type's signing keys,
A deeper understanding of accounts will help you to best setup NATS JWT based security.
- What entity do accounts correspond to:Our official suggestion is to scope accounts by application/service offered.This is very fine grained and will require some configuration.This is why some users gravitate to accounts per team. One account for all Applications of a team.It is possible to start out with less granular accounts and as applications grow in importance or scale become more fine grained.
- Compared to file based config, Imports and Exports change slightly.To control who gets to import an export, activation tokens are introduced.These are JWTs that an importer can embed.They comply to similar verification rules as user JWT, thus enabling a
nats-serverto check if the exporting account gave explicit consent.Due to the use of a token, the exporting account's JWT does not have to be modified for each importing account. - Updates of JWTs are applied as
nats-serverdiscover them- How this is done depends on the resolver
mem-resolverrequirenats-server --signal reloadto re-read all configured account JWTs,url-resolverandnats-resolverlisten on a dedicated update subject of the system account and applied if the file is valid,nats-resolverwill also also update the corresponding JWT file and compensate in case the update message was not received due to temporary disconnect.
- User JWTs only depend on the issuing Account NKEY, they do NOT depend on a particular version of an Account JWT,
- Depending on the change, the internal Account representation will be updated and existing connections re-evaluated.
- The System Account is the account under which
nats-serveroffers (administrative) services and monitoring events.
- Accounts can be arbitrarily scoped, from Application to Team,
- Account Exports can be restricted by requiring use of activation tokens,
- Receiving a more recent Account JWT causes the nats-server to apply changes and re evaluate existing connections.
This section will introduce
nsc cli to generate and manage operator/accounts/user. Even if you intend to primarily generate your Accounts/User programmatically, in all likelihood, you won't do so for an operator or all accounts. Key Management and how to do so using nsc will also be part of this section.It keeps track of the last operator/account used. Because of this, commands do not need to reference operator/accounts but can be instructed to do so (recommended for scripts). It supports an interactive mode when
-i is provided. When used, referencing accounts/keys is easier.nsc env will show where NKEYS/JWT are stored and what current defaults are. For testing you may want to switch between nsc environments: Changing the (JWT) store directory: nsc env --store <different folder> Changing the (NKEY) store directory by having an environment variable set: export NKEYS_PATH=<different folder>Subsequent sections will refer to different environments in context of different deployment modes. As such you can skip over all mentions for modes not of interest to you. The mixed deployment mode is not mentioned and left as an exercise to the reader.
Possessing NKEYS gives access to the system. Backups should therefore best be offline and access to them should be severely restricted. In cases where regenerating all/parts of the operator/accounts is not an option, signing NKEYs must be used and identity NKEYs should be archived and then removed from the original store directory, so that in the event of a data breach you can recover without a flag-day change-over of identities. Thus, depending on your scenario, relevant identity NKEYS need to only exist in very secure offline backup(s).
The store directory contains JWTs for operators, accounts, and users. It does not contain private keys. Therefore it is ok to back these up or even store them in a VCS such as git. But be aware that depending on content, JWT may reveal which permissions/subjects/public-nkeys exist. Knowing the content of a JWT does not grant access; only private keys will. However, organizations may not wish to make those public outright and thus have to make sure that these external systems are secured appropriately.
When restoring an older version, be aware that:
- All changes made since will be lost, specifically revocations may be undone,
- Time has moved on and thus JWTs that were once valid at the time of the backup or commit may be expired now. Thus you may have to be edit them to match your expectations again,
- NKEYS are stored in a separate directory, so not to restore a JWT for which the NKEY has been deleted since:
- Either keep all keys around; or
- Restore the NKEY directory in tandem.
JWTs allow you to specify names. But names do NOT represent an identity, they are only used to ease referencing of identities in our tooling. At no point are these names used to reference each other, instead, the public identity NKEY is used for that. The
nats-server does not read them at all. Because names do not relate to identity, they may collide. Therefore, when using nsc, these names need to be keep unique.Create operator with system account and system account user:
nsc add operator -n <operator-name> --sys
The command
nsc edit operator [flags] can subsequently be used to modify the operator. For example if you are setting the account server url (used by url-resolver and nats-resolver), nsc does not require them being specified on subsequent commands. nsc edit operator --account-jwt-server-url "nats://localhost:4222"Note that if you update an operator JWT that is installed on a server you will need to manually update the operator JWT and reload the server Whilenscis able to update accounts, it never updates the operator.
We always recommend using signing keys for an operator. Generate one for an operator (
-o) and store it in the key directory (--store). The output will display the public portion of the signing key, use that to assign it to the operator (--sk O...). nsc generate nkey -o --store followed by nsc edit operator --sk OB742OV63OE2U55Z7UZHUB2DUVGQHRA5QVR4RZU6NXNOKBKJGKF6WRTZ. To pick the operator signing key for account generation, provide the -i option when doing so.The system account is the account under which
nats-server offers system services as will be explained below in the system-account section. To access these services a user with credentials for the system account is needed. Unless this user is restricted with appropriate permissions, this user is essentially the admin user. They are created like any other user.For cases where signing keys are generated and immediately added
--sk generate will create an NKEY on the fly and assign it as signing NKEY.In order to import an Operator JWT, say the one just created, into a separate nsc environment maintained by a different entity/team, the following has to happen:
- 1.Obtain the operator JWT using:
nsc describe operator --rawand store the output in a file namedoperator.jwt. The option--rawcauses the raw JWT to be emitted, - 2.Exchange that file or it's content in any way you like, email works fine (as there are no credentials in the JWT),
- 3.Import the operator JWT into the second environment with:
nsc add operator -u operator.jwt.
If the operator should been changed and an update is required, simply repeat these steps but provide the
--force option in the last step. This will overwrite the stored operator JWT.In addition to the previous step, self service deployments require an operator signing key and a system account user. Ideally you would want an operator signing key per entity to distribute a signing key too. Simply repeat the command shown earlier but:
- 1.Perform
nsc generate nkey -o --storein this environment instead, - 2.Exchange the public key with the Administrator/Operator via a way that assures you sent the public key and not someone elses,
- 3.Perform
nsc edit operator --skin the operator environment, - 4.
To import the system account user needed for administrative purposes as well as monitoring, perform these steps:
- 1.Perform
nsc describe account -n SYS --rawand store the output in a file namedSYS.jwt.The option-nspecifies the (system) account namedSYS. - 2.Exchange the file,
- 3.Import the account
nsc import account --file SYS.jwt, - 4.Perform
nsc generate nkey -u --storein this environment, - 5.Exchange the public key printed by the command with the Administrator/Operator via a way that assures you sent the public key and not someone elses,
- 6.Create a system account user named (
-n) any way you like (here namedsys-non-op) providing (-k) the exchanged public keynsc add user -a SYS -n sys-non-op -k UDJKPL7H6QY4KP4LISNHENU6Z434G6RLDEXL2C64YZXDABNCEOAZ4YY2in the operator environment. (-areferences the AccountSYS.), - 7.If desired edit the user,
- 8.Export the user
nsc describe user -a SYS -n sys-non-op --rawfrom the operator environment and store it in a file namedsys.jwt. (-nreferences the usersys-non-op), - 9.Exchange the file,
- 10.Import the user in this environment using
nsc import user --file sys.jwt
As a result of these operations, your operator environment should have these keys and signing keys:
nsc list keys --all
+------------------------------------------------------------------------------------------------+
| Keys |
+--------------+----------------------------------------------------------+-------------+--------+
| Entity | Key | Signing Key | Stored |
+--------------+----------------------------------------------------------+-------------+--------+
| DEMO | OD5FHU4LXGDSGDHO7UNRMLW6I36QX5VPJXRQHFHMRUIKSHOPEDSHVPBB | | * |
| DEMO | OBYAIG4T4PVR6GVYDERN74RRW7VBKRWBTI7ULLMM6BRHUID4AAQL7SGA | * | |
| ACC | ADRB4JJYFDLWKIMX4DH6MX2DMKA3TENJWGMNVM5ILYLZTT6BN7QIF5ZX | | |
| SYS | AAYVLZJC2ULKSH5HNSKMIKFMCEHCNU5VOV5KG56IRL7ENHLBUGZ27CZT | | * |
| sys | UBVZYLLCAFMHBXBUDKKKFKH62T4AW7Q5MAAE3R3KKAIRCZNYITZPDQZ3 | | * |
| sys-non-op | UDJKPL7H6QY4KP4LISNHENU6Z434G6RLDEXL2C64YZXDABNCEOAZ4YY2 | | |
+--------------+----------------------------------------------------------+-------------+--------+
And your account should have the following ones:
nsc list keys --all
+------------------------------------------------------------------------------------------------+
| Keys |
+--------------+----------------------------------------------------------+-------------+--------+
| Entity | Key | Signing Key | Stored |
+--------------+----------------------------------------------------------+-------------+--------+
| DEMO | OD5FHU4LXGDSGDHO7UNRMLW6I36QX5VPJXRQHFHMRUIKSHOPEDSHVPBB | | |
| DEMO | OBYAIG4T4PVR6GVYDERN74RRW7VBKRWBTI7ULLMM6BRHUID4AAQL7SGA | * | * |
| SYS | AAYVLZJC2ULKSH5HNSKMIKFMCEHCNU5VOV5KG56IRL7ENHLBUGZ27CZT | | |
| sys-non-op | UDJKPL7H6QY4KP4LISNHENU6Z434G6RLDEXL2C64YZXDABNCEOAZ4YY2 | | * |
+--------------+----------------------------------------------------------+-------------+--------+
Between the two outputs, compare the
Stored column.Alternatively if the administrator is willing to exchange private keys and the exchange can be done securely, a few of these steps fall away. The signing key and system account user can be generated in the administrator/operator environment, omitting
--store to avoid unnecessary key copies. Then the public/private signing NKEYS are exchanged together with the system account user as creds file. A creds file can be generated with nsc generate creds -a SYS -n sys-non-op and imported into this environment with nsc import user --file sys.jwt. If the signing key is generated before the operator is imported into this environment, operator update falls away.Create an account as follows:
nsc add account -n <account name> -i
In case you have multiple operator signing keys
-i will prompt you to select one. nsc edit account [flags] can subsequently be used to modify the account. (Edit is also applicable to the system account)Similar to the operator signing keys are recommended. Generate signing key for an account (
-a) and store it in the key directory maintained by nsc (--store) The output will display the public portion of the signing key, use that to assign it to the account (--sk A...) nsc generate nkey -a --store nsc edit account --sk ACW2QC262CIQUX4ACGOOS5XLKSZ2BY2QFBAAOF3VOP7AWAVI37E2OQZX To pick the signing key for user generation, provide the -i option when doing so.In this mode, the created account is self-signed. To have it signed by the operator perform these steps:
- 1.In this environment export the created account as a JWT like this
nsc describe account -n <account name> --raw.Store the output in a file namedimport.jwt. - 2.Exchange the file with the Administrator/Operator via a way that assures it is your JWT and not someone elses.
- 3.In the operator environment import the account with
nsc import account --file import.jwt.This step also re-signs the JWT so that it is no longer self-signed. - 4.The Administrator/operator can now modify the account with
nsc edit account [flags]
If the account should be changed and an update is required, simply repeat these steps but provide the
--force option during the last step. This will overwrite the stored account JWT.This environment is set up with a signing key, thus the account is already created properly signed. The only step that is needed is to push the Account into the NATS network. However, this depends on your ability to do so. If you have no permissions, you have to perform the same steps as for the decentralized deployment mode. The main difference is that upon import, the account won't be re-signed.
How accounts can be publicized wholly depends on the resolver you are using:
- url-resolver:
nsc pushwill send an HTTP POST request to the hosting webserver ornats-account-server, nats-resolver: Every environment with a system account user that has permissions to send properly signed account JWT as requests to:$SYS.REQ.CLAIMS.UPDATEcan upload and update all accounts. Currently,nsc pushuses this subject.$SYS.REQ.ACCOUNT.*.CLAIMS.UPDATEcan upload and update specific accounts.
nsc generate config <resolver-type> is an utility that generates the relevant NATS config. Where <resolver-type> can be --mem-resolver or --nats-resolver for the corresponding resolver. Typically the generated output is stored in a file that is then included by the NATS config. Every server within the same authentication domain needs to be configured with this configuration.This is a quick demo of the nats-based resolver from operator creation to publishing a message. Please be aware that the ability to push only relates to permissions to do so and does not require an account keys. Thus, how accounts to be pushed into the environment (outright creation/import) does not matter. For simplicity, this example uses the operator environment.
Operator Setup:
nsc add operator -n DEMO --sys
[ OK ] generated and stored operator key "ODHUVOUVUA3XIBV25XSQS2NM2UN4IKJYLAMCGLWRFAV7F7KUWADCM4K6"
[ OK ] added operator "DEMO"
[ OK ] created system_account: name:SYS id:AA6W5MRDIFIQWE6UE6D4YWQT5L4YZG7ZRHSKYCPF2VIEMUHRZH3VQZ27
[ OK ] created system account user: name:sys id:UABM73CE5F3ZYFNC3ZDODAF7GIB62W2WXV5DOLMYLGEW4MEHYBC46PN4
[ OK ] system account user creds file stored in `~/test/demo/env1/keys/creds/DEMO/SYS/sys.creds`
nsc edit operator --account-jwt-server-url nats://localhost:4222
[ OK ] set account jwt server url to "nats://localhost:4222"
[ OK ] edited operator "DEMO"
Inspect the setup:
nsc list keys --all
+------------------------------------------------------------------------------------------+
| Keys |
+--------+----------------------------------------------------------+-------------+--------+
| Entity | Key | Signing Key | Stored |
+--------+----------------------------------------------------------+-------------+--------+
| DEMO | ODHUVOUVUA3XIBV25XSQS2NM2UN4IKJYLAMCGLWRFAV7F7KUWADCM4K6 | | * |
| SYS | AA6W5MRDIFIQWE6UE6D4YWQT5L4YZG7ZRHSKYCPF2VIEMUHRZH3VQZ27 | | * |
| sys | UABM73CE5F3ZYFNC3ZDODAF7GIB62W2WXV5DOLMYLGEW4MEHYBC46PN4 | | * |
+--------+----------------------------------------------------------+-------------+--------+
nsc describe operator:+-------------------------------------------------------------------------------+
| Operator Details |
+--------------------+----------------------------------------------------------+
| Name | DEMO |
| Operator ID | ODHUVOUVUA3XIBV25XSQS2NM2UN4IKJYLAMCGLWRFAV7F7KUWADCM4K6 |
| Issuer ID | ODHUVOUVUA3XIBV25XSQS2NM2UN4IKJYLAMCGLWRFAV7F7KUWADCM4K6 |
| Issued | 2020-11-04 19:25:25 UTC |
| Expires | |
| Account JWT Server | nats://localhost:4222 |
| System Account | AA6W5MRDIFIQWE6UE6D4YWQT5L4YZG7ZRHSKYCPF2VIEMUHRZH3VQZ27 |
+--------------------+----------------------------------------------------------+
nsc describe account: