Merged in pat-permissioning-doc (pull request #545)

doc : Network Permissioning

docs/source/corda-configuration-files.rst

@@ -39,6 +39,9 @@ NetworkMapService plus Simple Notary configuration file.
     webAddress : "localhost:12346"
     extraAdvertisedServiceIds: ""
     useHTTPS : false
+    devMode = true
+    // Certificate signing service will be hosted by R3 in the near future.
+    //certificateSigningService = "https://testnet.certificate.corda.net"
 
 Configuration File Fields
 -------------------------
@@ -94,3 +97,9 @@ Configuration File Fields
         :permissions: A list of permission strings which RPC methods can use to control access
 
     If this field is absent or an empty list then RPC is effectively locked down.
+    
+:devMode:
+    This flag indicate if the node is running in development mode. On startup, if the keystore ``<workspace>/certificates/sslkeystore.jks`` does not exist, a developer keystore will be used if ``devMode`` is true. The node will exit if ``devMode`` is false and keystore does not exist.
+    
+:certificateSigningService:
+    Certificate Signing Server address. It is used by the certificate signing request utility to obtain SSL certificate. (See :doc:`permissioning` for more information.)

docs/source/example-code/src/main/resources/example-node.conf

@@ -17,3 +17,6 @@ useHTTPS : false
 rpcUsers : [
     { user=user1, password=letmein, permissions=[ StartProtocol.net.corda.protocols.CashProtocol ] }
 ]
+devMode = true
+// Certificate signing service will be hosted by R3 in the near future.
+//certificateSigningService = "https://testnet.certificate.corda.net"

docs/source/index.rst

@@ -51,6 +51,8 @@ Read on to learn:
    corda-configuration-files
    corda-plugins
    node-services
+   node-explorer
+   permissioning
 
 .. toctree::
    :maxdepth: 2
@@ -78,7 +80,6 @@ Read on to learn:
    :caption: Other
 
    network-simulator
-   node-explorer
    initial-margin-agreement
 
 .. toctree::

docs/source/permissioning.rst

@@ -0,0 +1,64 @@
+Network Permissioning
+=====================
+
+The keystore located in ``<workspace>/certificates/sslkeystore.jks`` is required to connect to the Corda network securely. 
+In development mode (when ``devMode = true``, see :doc:`corda-configuration-files` for more information) a pre-configured keystore will be used if the keystore does not exist. 
+This is to ensure developers can get the nodes working as quickly as possible.
+
+However this is not secure for the real network. This documentation will explain the procedure of obtaining a signed certificate for TestNet. 
+
+.. warning:: The TestNet has not been setup yet as of Milestone 6 release. You will not be able to connect to the certificate signing server. 
+
+Certificate Signing Request Utility
+-----------------------------------
+
+The utility creates certificate signing request based on node information obtained from the node configuration. 
+The following information from the node configuration file is needed to generate a certificate signing request.
+
+:myLegalName: Your company's legal name. e.g. "R3 CEV, LLC"
+
+:nearestCity:  e.g. "London"
+
+:emailAddress: e.g. "admin@company.com"
+
+:certificateSigningService: Certificate signing server URL. A certificate signing server will be hosted by R3 in the near future.  e.g."https://testnet.certificate.corda.net"
+
+A new pair of private and public keys will be generated by the utility and will be used to create the request.
+
+The utility will submit the request to the network permissioning server and poll for a result periodically to retrieve the certificates.
+Once the request has been approved and the certificates downloaded from the server, the utility will create the key store and trust store using the certificates and the generated private key.
+
+.. note:: You can exit the utility at anytime if the approval process is taking longer then expected. The request process will resume on restart. 
+
+This process only needs to be done once when the node connects to the network for the first time, or when the certificate expires.
+
+Building the Utility
+--------------------
+The utility will be created as part of the main build ``buildCordaJAR``.
+You can also build the utility JAR by run the following command from the Corda project root directory.
+
+**Windows**::
+
+    gradlew.bat buildCertSigningRequestUtilityJAR
+
+**Other**::
+
+    ./gradlew buildCertSigningRequestUtilityJAR
+
+The utility JAR will be created in ``<Project Root Dir>/build/libs/certSigningRequestUtility.jar``
+
+
+Running the Utility
+-------------------
+
+You will need to specify the working directory of your Corda node using ``--base-dir`` flag. This is defaulted to current directory if left blank.
+You can also specify the location of ``node.conf`` with ``--config-file`` flag if it's not in the working directory.
+
+**Running the Utility**::
+
+    java -jar certSigningRequestUtility.jar --base-dir <<optional>> --config-file <<optional>>
+
+A ``certificates`` folder containing the keystore and trust store will be created in the base directory when the process is completed.
+
+.. warning:: The keystore is protected by the keystore password from the node configuration file. The password should kept safe to protect the private key and certificate.
+.. note:: Password encryption in node configuration will be supported in subsequent release.