diff options
author | Ulf Wiger <ulf@feuerlabs.com> | 2016-02-24 20:55:26 +0100 |
---|---|---|
committer | Ulf Wiger <ulf@feuerlabs.com> | 2016-02-24 20:55:26 +0100 |
commit | 33c6854a7cb6220c5fc0500457028f19ed237214 (patch) | |
tree | 8e7616e062a3da513a32245399fffaa2d25a3b45 | |
parent | f7ea6e3b12dd343cefd0565be87cef4329e51124 (diff) | |
download | rvi_core-33c6854a7cb6220c5fc0500457028f19ed237214.tar.gz |
generate PDF files
-rw-r--r-- | BUILD.md | 13 | ||||
-rw-r--r-- | doc/pdf/BUILD.pdf | bin | 295900 -> 321115 bytes | |||
-rw-r--r-- | doc/pdf/CONFIGURE.pdf | bin | 1642409 -> 1654047 bytes | |||
-rw-r--r-- | doc/pdf/rvi_certificates.pdf | bin | 0 -> 595909 bytes | |||
-rw-r--r-- | doc/pdf/rvi_fragmentation.pdf | bin | 424532 -> 428947 bytes | |||
-rw-r--r-- | doc/pdf/rvi_protocol.pdf | bin | 1083617 -> 738301 bytes | |||
-rw-r--r-- | doc/pdf/rvi_services.pdf | bin | 1576836 -> 1667867 bytes | |||
-rw-r--r-- | doc/rvi_certificates.md | 8 | ||||
-rw-r--r-- | doc/rvi_protocol.md | 2 | ||||
-rw-r--r-- | doc/rvi_services.md | 25 |
10 files changed, 24 insertions, 24 deletions
@@ -1,9 +1,4 @@ -<style type="text/css" media="print"> - div.pagebreak - { - page-break-before: always; - } -</style> +<style type="text/css" media="print"> div.pb { page-break-before: always; } </style> Copyright (C) 2014-2016, Jaguar Land Rover This document is licensed under Creative Commons @@ -43,7 +38,7 @@ Please note that the configuration process described in ---- -<div class="pagebreak"></div> +<div class="pb"></div> # INSTALLATION PROCESS # @@ -88,7 +83,7 @@ to the build system. The clone will be downloaded into a newly created ```rvi_core``` subdirectory. ----- +<div class="pb"></div> ## BUILD THE RVI SYSTEM ## @@ -101,8 +96,6 @@ The local ```rebar``` command is used to retrieve the dependencies. See ```rebar.config``` and ```deps/*/rebar.config``` for a list of dependencies. -<div class="pagebreak"></div> - See the [rebar](https://github.com/basho/rebar) project for a detailed description of the rebar Erlang build tool. diff --git a/doc/pdf/BUILD.pdf b/doc/pdf/BUILD.pdf Binary files differindex dc14200..d7e886b 100644 --- a/doc/pdf/BUILD.pdf +++ b/doc/pdf/BUILD.pdf diff --git a/doc/pdf/CONFIGURE.pdf b/doc/pdf/CONFIGURE.pdf Binary files differindex 013da57..d4afa45 100644 --- a/doc/pdf/CONFIGURE.pdf +++ b/doc/pdf/CONFIGURE.pdf diff --git a/doc/pdf/rvi_certificates.pdf b/doc/pdf/rvi_certificates.pdf Binary files differnew file mode 100644 index 0000000..f3cc127 --- /dev/null +++ b/doc/pdf/rvi_certificates.pdf diff --git a/doc/pdf/rvi_fragmentation.pdf b/doc/pdf/rvi_fragmentation.pdf Binary files differindex 754566d..164bd82 100644 --- a/doc/pdf/rvi_fragmentation.pdf +++ b/doc/pdf/rvi_fragmentation.pdf diff --git a/doc/pdf/rvi_protocol.pdf b/doc/pdf/rvi_protocol.pdf Binary files differindex 95f72e1..1030081 100644 --- a/doc/pdf/rvi_protocol.pdf +++ b/doc/pdf/rvi_protocol.pdf diff --git a/doc/pdf/rvi_services.pdf b/doc/pdf/rvi_services.pdf Binary files differindex b42829f..bfc5f21 100644 --- a/doc/pdf/rvi_services.pdf +++ b/doc/pdf/rvi_services.pdf diff --git a/doc/rvi_certificates.md b/doc/rvi_certificates.md index 7b10292..1d46259 100644 --- a/doc/rvi_certificates.md +++ b/doc/rvi_certificates.md @@ -104,6 +104,8 @@ openssl x509 -req -days 365 -in insecure_device_cert.csr \ The ```insecure_device_cert.csr``` intermediate certificate signing request can be deleted once the three steps above have been executed. +<div class="pb"></div> + The content of the sample ```insecure_device_key.pem``` private key file, which has no password protection, is: @@ -125,8 +127,6 @@ G9jkH/AfO35GP3RiWQJBAJLWBlKpHf8TxT65jAwxBhd9ZOkC2w0WidbSYjX9wkkD -----END RSA PRIVATE KEY----- ``` -<div class="pb"></div> - The content of the sample ```insecure_device_cert.crt``` file is: ``` @@ -145,11 +145,13 @@ PwSMHih1bsTRpyY5Z3CUDcDJkYtVbYs= -----END CERTIFICATE----- ``` -These files are checked into ```priv/certifcates``` and ```priv/keys```. +These files are checked into ```priv/certificates``` and ```priv/keys```. **DO NOT USE THE KEYS AND CERTIFICATES ABOVE IN PRODUCTION!<br> ANY PRODUCTION KEYS SHOULD BE GENERATED BY THE ORGANIZATION AND BE 4096 BITS LONG.** +<div class="pb"></div> + ## RVI credentials format A credential is a JWT-encoded JSON structure, signed by the root X.509 diff --git a/doc/rvi_protocol.md b/doc/rvi_protocol.md index 6536111..85c3290 100644 --- a/doc/rvi_protocol.md +++ b/doc/rvi_protocol.md @@ -193,6 +193,8 @@ Currently supported RVI options are * `"rvi.max_msg_size"` (integer > 0) * `"rvi.reliable"` (true | false) +<div class="pb"></div> + ## Double connect resolution There is a risk that two parties try to initiate a connection to each other in a race condition, creating two connections between them, as diff --git a/doc/rvi_services.md b/doc/rvi_services.md index 9a288d4..ce32997 100644 --- a/doc/rvi_services.md +++ b/doc/rvi_services.md @@ -38,7 +38,7 @@ manage all subpaths below itself. A typical service name for a vehicle that specifies a service to lock a door: message:jaguarlandrover.com/vin/1HGCM82633A004352/services/body/lock - + Services can freely be defined and implemented by anyone for any purpose as long as the global name space is not violated (hence the organization). RVI defines a couple of core services that are specified by this document. @@ -60,7 +60,7 @@ Procedure Calls (RPC) (JSON-RPC). "reporting_interval": 5000 } } - + * jsonrpc - JSON-RPC version number. * id - Request ID, used to match the response to the request. * method - Method to be invoked. For RVI the method is ```message```. @@ -101,7 +101,7 @@ The parameters are: * keyid - Unique key ID. * key - JWT encoded key, signed by the private root key, where the payload is a JWK-formatted JSON object. - + After receiving a key the device will typically store it in its key store. <div class="pb"></div> @@ -128,7 +128,7 @@ The parameters are: * certid - Unique certificate ID. * checksum - The md5 checksum calculated over the entire certificate * certificate - The certificate encoded as base64. - + After receiving a certificate the device will typically store it in its certificate store. @@ -150,7 +150,7 @@ Erase a certificate from the device's certificate store. The parameters are: * certid - Unique certificate ID. - + After receiving an erase certificate request the device must remove it from its certificate store. @@ -175,7 +175,6 @@ The parameters are: * dummy - Placeholder parameter - After receiving an erase certificate request the device must remove all certificates from its certificate store. @@ -199,7 +198,7 @@ from it. The parameters are: * certid - Unique certificate ID. - + After receiving a revoke certificate request the device must add it to its certificate blacklist. When the device is presented with a blacklisted certificate or a certificate that has been derived from a blacklisted certificate it must @@ -209,6 +208,8 @@ reject that certificate as invalid. Services to manage device configuration. +<div class="pb"></div> + ##### Read Configuration Variables Retrieve the value of one or more configuration variables from the device. @@ -229,7 +230,7 @@ The server sends to the device: The parameters are: * variable - The name of the variable. - + The device responds with: { @@ -246,7 +247,7 @@ The device responds with: ] } } - + The parameters are: * vin - The VIN of the device reporting the variable. @@ -359,7 +360,7 @@ The parameters are: match the ID from the `notify` message this message is sent in response to. -<div class="pg"></div> +<div class="pb"></div> #### Start Download @@ -696,8 +697,8 @@ The parameters are: * duration - The duration, in milliseconds, that the lights should be on for +<div class="pb"></div> - #### Windows Open/close windows and other hatches @@ -713,6 +714,8 @@ Open/close windows and other hatches } } +<div class="pb"></div> + The parameters are: * windows - The windows to operate on |