Repo Protocol Specification » History » Version 9
Alex Afanasyev, 02/18/2014 09:12 PM
| 1 | 1 | Shuo Chen | Repo Protocol Specification |
|---|---|---|---|
| 2 | =========================== |
||
| 3 | |||
| 4 | 2 | Shuo Chen | Repo is persistent storage of data objects model in NDN. The NDN repo protocol is a specification of repo operations including reading, insertion and deletion of data objects in repo. |
| 5 | |||
| 6 | Repo semantics is based on [Command Interests](http://redmine.named-data.net/projects/nfd/wiki/Command_Interests) with signed commponents an the end of the name and basic common semantics of NDN. |
||
| 7 | |||
| 8 | 4 | Shuo Chen | When some operation of repo including insertion and deletion of data objects is requested, a starter interest is sent. The starter interest is the interest as command of insertion and deletion and signed as form of command interest for access control. The repo will response the command with the data object. |
| 9 | |||
| 10 | The repo protocol can be categorized in three sections of reading, insertion and deletion of data objects. |
||
| 11 | |||
| 12 | ## Repo Reading Specification |
||
| 13 | |||
| 14 | The repo could be viewed as the data container of the data objects. It will register some specific prefixes of data objects it holds into NFD (NDN Forwarding Deamon). The prefix of data objects that repo will respond will following such semantics. |
||
| 15 | |||
| 16 | ### Semantics of data objects that repo manages |
||
| 17 | |||
| 18 | The name semantics is defined to have following components,: |
||
| 19 | |||
| 20 | * ``<box of repo>`` refers to specific name of repo |
||
| 21 | 6 | Shuo Chen | * ``%R`` refers to data objects |
| 22 | 4 | Shuo Chen | * ``<data name>`` refers to specific name of data |
| 23 | |||
| 24 | <box of repo> and <data name> can be divided by serveral continious ``/`` according to specific defination. |
||
| 25 | |||
| 26 | For example, for ``<box of repo>`` as ``/ucla/cs/repo`` and ``<data name>`` as ``/vedio/Forrest Gump/s1/v1``, the data object is defined as following: |
||
| 27 | |||
| 28 | 8 | Shuo Chen | /ucla/cs/repo/%R/vedio/Forrest Gump/s1/v1 |
| 29 | 6 | Shuo Chen | |
| 30 | A standard interest with such semantics is used to fetch content from the repo. The repo will respond when the name of the interest matches the prefix it registered in NFD. If the content in repo matches the interests, it will respond with the data object. When the interest is not matched, it will not respond. |
||
| 31 | |||
| 32 | The protocol is listed as bellow |
||
| 33 | |||
| 34 | If there is a matching data object: |
||
| 35 | |||
| 36 | 7 | Shuo Chen | Requester Repo |
| 37 | | | |
||
| 38 | | | |
||
| 39 | | Interest | |
||
| 40 | t1 |-------------------------->| |
||
| 41 | | | |
||
| 42 | | Data Object | |
||
| 43 | t2 |<==========================| |
||
| 44 | | | |
||
| 45 | | | |
||
| 46 | | | |
||
| 47 | 6 | Shuo Chen | |
| 48 | If there is no matching data object: |
||
| 49 | |||
| 50 | 7 | Shuo Chen | Requester Repo |
| 51 | | | |
||
| 52 | | | |
||
| 53 | | Interest | |
||
| 54 | t1 |-------------------------->| |
||
| 55 | | | |
||
| 56 | | | |
||
| 57 | 1 | Shuo Chen | | | |
| 58 | 8 | Shuo Chen | |
| 59 | ## Repo Insertion Specification |
||
| 60 | |||
| 61 | Insertion specification is for some client and application to insert data objects into certain NDN repo. A starter interest as insertion command will be sent to the repo. This starter interest is a signed interest and will be validated with access control policy defined by the repo. When the interested is validated and name of the data is not existed in the repo. The repository will reponse with a data object containing OK status and start to send the interest to fetch the data to insert. |
||
| 62 | |||
| 63 | ### Insertion starter interest semantics |
||
| 64 | |||
| 65 | |||
| 66 | The name semantics is defined to have following components: |
||
| 67 | |||
| 68 | * ``<box of repo>`` refers to specific name of repo |
||
| 69 | * ``%I`` refers to insert data objects |
||
| 70 | * ``<data name>`` refers to specific name of data that will be inserted |
||
| 71 | |||
| 72 | The folloing components are components of singed interest for access control: |
||
| 73 | 9 | Alex Afanasyev | |
| 74 | 8 | Shuo Chen | * ``<timestamp>`` |
| 75 | * ``<random-value>`` |
||
| 76 | * ``<SignatureInfo>`` |
||
| 77 | * ``<SignatureValue>`` |
||
| 78 | |||
| 79 | <box of repo> and <data name> can be divided by serveral continious ``/`` according to specific defination. |
||
| 80 | For example, for ``<box of repo>`` as ``/ucla/cs/repo`` and ``<data name>`` as ``/vedio/Forrest Gump/s1/v1``, the data object is defined as following: |
||
| 81 | |||
| 82 | /ucla/cs/repo/%R/vedio/Forrest Gump/s1/v1/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue> |