ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-18 20:47:57 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #5935 from corda/denis/ENT-4926-node-identity-docs

Browse Source 
ENT-4915, ENT-4926, CORDA-3585: Update docs for X500 name and SSH hostkey
This commit is contained in:
Matthew Nesbit 2020-02-20 11:11:46 +00:00 committed by GitHub
commit 9dec5aac4b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source/node-naming.rst
View File

@ -27,9 +27,11 @@ The name must also obey the following constraints:
* The ``organisation``, ``locality`` and ``country`` attributes are present * The ``organisation``, ``locality`` and ``country`` attributes are present
* The ``state``, ``organisational-unit`` and ``common name`` attributes are optional * The ``state``, ``organisational-unit`` and ``common name`` attributes are optional
* The fields of the name have the following maximum character lengths: * The maximum number of characters in the whole x500 name string is 128 characters
* The fields of the name have character lengths **less** than the following maximum values:
* Common name: 64 * Common name: 64
* Organisation: 128 * Organisation: 128
@ -40,12 +42,18 @@ The name must also obey the following constraints:
* The ``country`` attribute is a valid `ISO 3166-1<https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2>` two letter code in upper-case * The ``country`` attribute is a valid `ISO 3166-1<https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2>` two letter code in upper-case
* The ``organisation`` field of the name obeys the following constraints: * The ``organisation`` field of the name obeys the following constraints:
* Has at least two letters * Has at least two letters
* Does not include the following characters: ``,`` , ``"``, ``\``
* All data fields adhere to the following constraints:
* Upper-case first letter
* Does not include the following characters: ``,``, ``=``, ``$``, ``"``, ``'``, ``\``
* Is in NFKC normalization form * Is in NFKC normalization form
* Does not contain the null character * Does not contain the null character
* Only the latin, common and inherited unicode scripts are supported * Only the latin, common and inherited unicode scripts are supported
* No double-spacing * No double-spacing
* No leading or trailing whitespace
This is to avoid right-to-left issues, debugging issues when we can't pronounce names over the phone, and This is to avoid right-to-left issues, debugging issues when we can't pronounce names over the phone, and
character confusability attacks. character confusability attacks.

2
docs/source/shell.rst
View File

@ -91,6 +91,8 @@ The host key is loaded from the ``<node root directory>/sshkey/hostkey.pem`` fil
generated automatically. In development mode, the seed may be specified to give the same results on the same computer generated automatically. In development mode, the seed may be specified to give the same results on the same computer
in order to avoid host-checking errors. in order to avoid host-checking errors.
Only RSA key is currently supported as a host key. If ``hostkey.pem`` is not RSA, it will be replaced by the newly generated RSA key.
Connecting to the shell Connecting to the shell
*********************** ***********************