diff --git a/api/connection.rst b/api/connection.rst index 6bab135..89f6c7a 100644 --- a/api/connection.rst +++ b/api/connection.rst @@ -13,8 +13,8 @@ Add some links to docs on websockets and json.... Authentication ============== -Once a websocket connection is made to the server, the client needs to use the authentication class to authenticate itself to obtain access to the sysadm service. Every authentciation class -request contains the following parameters: +Once a websocket connection is made to the server, the client needs to use the authentication class to authenticate itself to obtain access to the sysadm service. Every authentciation +class request contains the following parameters: +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Value** | **Description** | @@ -34,8 +34,9 @@ request contains the following parameters: +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ -Several methods are available for authentication. Here is an example of a login using a username and password: -(Note: When connecting to the localhost, the password field may be left empty for non-root user access). +Several methods are available for authentication. Here is an example of a login using a username and password. + +.. note:: when connecting to the localhost, the password field may be left empty for non-root user access. **WebSocket Request** @@ -66,8 +67,8 @@ Here is an example of using token authentication, where the token is invalidated } } -Here is an example of using a pre-registered SSL certificate to request authentication: -(Note: This is a two step process with only a 30 seconds window of validity, so this is best left up to automated systems rather than direct user requests). +Here is an example of using a pre-registered SSL certificate to request authentication. Note that this is a two-step process with only a 30 seconds window of validity, so this is best +left to automated systems rather than direct user requests. **WebSocket Request (Stage 1 - Initial Request)** @@ -78,8 +79,8 @@ Here is an example of using a pre-registered SSL certificate to request authenti "name" : "auth_ssl", "id" : "sampleID", "args" : "" - } -.. + } + **WebSocket Reply (Stage 1)** .. code-block:: json @@ -92,11 +93,12 @@ Here is an example of using a pre-registered SSL certificate to request authenti "name": "response", "namespace": "rpc" } -.. -On receipt of the test_string, the user-side client must encrypt that string with the desired SSL certificate/key combination, then return that encrypted string back to the server (Stage 2) within 30 seconds of the initial stage 1 reply. The encrypted string should also be base64-encoded before insertion into the stage 2 JSON request to ensure accurate transport back to the server. +On receipt of the "test_string", the user-side client must encrypt that string with the desired SSL certificate/key combination, then return that encrypted string back to the server +(Stage 2) within 30 seconds of the initial stage 1 reply. The encrypted string should also be base64-encoded before insertion into the stage 2 JSON request to ensure accurate transport +back to the server. -**WebSocket Request (Stage 2 - Return encoded string)** +**WebSocket Request (Stage 2 - Return Encoded String)** .. code-block:: json @@ -108,7 +110,6 @@ On receipt of the test_string, the user-side client must encrypt that string wit "encrypted_string" : "" } } -.. A successful authentication will provide a reply similar to this: @@ -126,9 +127,9 @@ A successful authentication will provide a reply similar to this: "namespace": "rpc" } -.. _note: the first element of the *"args"* array is the authentication token for use later as necessary, while the second element is the number of seconds for which that token is valid. - The token is reset after every successful communication with the websocket. In this example, it is set to 5 minutes of inactivity before the token is invalidated. The websocket server is - currently set to close any connection to a client after 10 minutes of inactivity. +.. note:: the first element of the "args" array is the authentication token for use later as necessary, while the second element is the number of seconds for which that token is valid. + The token is reset after every successful communication with the websocket. In this example, it is set to 5 minutes of inactivity before the token is invalidated. The websocket server + is currently set to close any connection to a client after 10 minutes of inactivity. An invalid authentication, or a system request after the user session has timed out due to inactivity, looks like this: