Merge pull request #2 from lukehinds/add-content

Test Formating for Rest API
keylime · Apr 11, 2019 · 17bba22 · 17bba22
2 parents 10d0a6a + 4236891
commit 17bba22
Show file tree

Hide file tree

Showing 6 changed files with 113 additions and 4 deletions.
diff --git a/docs/developers.rst b/docs/developers.rst
@@ -0,0 +1,3 @@
+==========
+Developers
+==========
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,12 +1,30 @@
-=================================================
-Welcome to Keylime Documentation's documentation!
-=================================================
+=====================
+Keylime Documentation
+=====================
+
+Welcome to Keylimes Documentation site!
+
+Keylime is a TPM based highly scaleable remote boot attestation and runtime
+integrity measurement solution. Keylime enables cloud users to monitor remote
+nodes using a hardware based cryptographic root of trust.
+
+Keylime was originally born out of the security research team in MIT's Lincoln
+Laboratory and is not developed and maintained by the Keylime community.
+
+This Documentation site contains user guides to install, use and adminster
+keylime as well as guides to enable developers to make contributions to keylime
+or develop services against Keylimes Rest API(s).
+
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-
+   installation
+   user_guide
+   rest_apis
+   developers
+   security
 
 Indices and tables
 ==================

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,3 @@
+============
+Installation
+============
diff --git a/docs/rest_apis.rst b/docs/rest_apis.rst
@@ -0,0 +1,79 @@
+==========
+Rest API's
+==========
+
+https://docs.readthedocs.io/en/stable/api/v2.html
+
+All Keylime APIs use `REST (Representational State Transfer)`.
+
+Authentication and authorization
+--------------------------------
+
+Not yet implemented
+
+tenant -> cloud verifier (CV)
+++++++++++++++++++++++++++++
+
+.. http:get::  /v2/agents/{agent_id:UUID}
+
+    Get status of agent `agent_id` from CV
+
+    **Example request**:
+
+    .. prompt:: bash $
+
+        curl https://readthedocs.org/api/v2/project/?slug=pip
+
+    **Example response**:
+
+    .. sourcecode:: js
+
+        {
+            "count": 1,
+            "next": null,
+            "previous": null,
+            "results": [PROJECTS]
+        }
+
+    :>json string next: URI for next set of Projects.
+    :>json string previous: URI for previous set of Projects.
+    :>json integer count: Total number of Projects.
+    :>json array results: Array of ``Project`` objects.
+
+    :query string slug: Narrow the results by matching the exact project slug
+
+    .. http:post::  /v2/agents/{agent_id:UUID}
+
+        Add new agent `instance_id` to CV
+
+        **Requires JSON Body**:
+
+        .. sourcecode:: js
+
+        {
+            “v” : key,
+            “ip” : ipaddr,
+            “port” : int,
+            “operational_state” : int,
+            “public_key” : key,
+            “tpm_policy” : json,
+            “vtpm_policy” : json,
+            “metadata” : json,
+            “ima_whitelist” : json,
+            “accept_tpm_hash_algs”: list,
+            “accept_tpm_encryption_algs”: list,
+            “accept_tpm_signing_algs”: list,
+        }
+
+        :>json string next: URI for next set of Projects.
+        :>json string previous: URI for previous set of Projects.
+        :>json integer count: Total number of Projects.
+        :>json array results: Array of ``Project`` objects.
+
+        :query string slug: Narrow the results by matching the exact project slug
+
+        **Example request**:
+
+        .. prompt:: bash $
+
+            curl https://readthedocs.org/api/v2/project/?slug=pip
diff --git a/docs/security.rst b/docs/security.rst
@@ -0,0 +1,3 @@
+================
+Securing Keylime
+================
diff --git a/docs/user_guide.rst b/docs/user_guide.rst
@@ -0,0 +1,3 @@
+==========
+User Guide
+==========