Project

General

Profile

Repo Command » History » Version 3

Weiqi Shi, 07/24/2014 02:31 PM

1 1 Alex Afanasyev
Repo Command
2
============
3
4
For insertion, deletion and other operations of repo, these commands are encoded in the form of [[ndn-cxx:SignedInterest|Signed Interests]]:
5
6
    /<repo-prefix>/<command-verb>/................./.........................................
7
                                  \______  _______/ \__________________  ___________________/
8
                                         \/                            \/
9
                                 RepoCommandParameter   Signed Interest additional components
10
11
The semantics of repo command interest is as follows:
12
13
The name semantics is defined to have following components:
14
15
* ``<repo prefix>`` refers to specific prefix repo is listening
16
* ``<command verb>`` refers to the name of command
17
* ``<RepoCommandParameter>`` refers to parameters of repo command
18
19
The following components are components of singed interest for access control:
20
21
* ``<timestamp>``
22
* ``<random-value>``
23
* ``<SignatureInfo>``
24
* ``<SignatureValue>``
25
26
For prefix of repo /ucla/cs/repo/, the command will be defined as this:
27
28
    /ucla/cs/repo/<command verb>/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
29
30
### RepoCommandParameter
31
32
    RepoCommandParameter ::= REPOCOMMANDPARAMETER-TYPE TLV-LENGTH
33
                               Name?
34
                               Selectors?
35
                               StartBlockId?
36
                               EndBlockId?
37
                               ProcessId?
38
39
    Name                  ::= NAME-TYPE TLV-LENGTH NameComponent*
40
    NameComponent         ::= NAME-COMPONENT-TYPE TLV-LENGTH BYTE+
41
42
    Selectors             ::= SELECTORS-TYPE TLV-LENGTH
43
                               MinSuffixComponents?
44
                               MaxSuffixComponents?
45
                               PublisherPublicKeyLocator?
46
                               Exclude?
47
                               ChildSelector?
48
49
    MinSuffixComponents   ::= MIN-SUFFIX-COMPONENTS-TYPE TLV-LENGTH
50
                               nonNegativeInteger
51
52
    MaxSuffixComponents   ::= MAX-SUFFIX-COMPONENTS-TYPE TLV-LENGTH
53
                               nonNegativeInteger
54
55
    PublisherPublicKeyLocator ::= KeyLocator
56
57
    Exclude               ::= EXCLUDE-TYPE TLV-LENGTH Any? (NameComponent (Any)?)+
58
    Any                   ::= ANY-TYPE TLV-LENGTH(=0)
59
60
    ChildSelector         ::= CHILD-SELECTOR-TYPE TLV-LENGTH
61
                               nonNegativeInteger
62
    
63
    StartBlockId          ::= STARTBLOCKID-TYPE TLV-LENGTH
64
                               nonNegativeInteger
65
    
66
    EndBlockId            ::= ENDBLOCKID-TYPE TLV-LENGTH
67
                               nonNegativeInteger
68
69 3 Weiqi Shi
    ProcessId             ::= PROCESSID-TYPE TLV-LENGTH
70
                               nonNegativeInteger
71
72
    MaxInterestNum        ::= MAX-INTEREST-NUM-TYPE TLV-LENGTH
73
                               nonNegativeInteger
74
75
    WatchTimeout          ::= WATCH-TIMEOUT-TYPE TLV-LENGTH
76
                               nonNegativeInteger
77
78
    WatchStatus           ::= WATCH-STATUS-TYPE TLV-LENGTH
79
                               nonNegativeInteger
80
81
    InterestTimeout       ::= INTEREST-TIMEOUT-TYPE TLV-LENGTH
82 1 Alex Afanasyev
                               nonNegativeInteger
83
84
#### Repo Command Selectors
85
86
Repo command supports parts of interest selectors of interest to indicate which contents to process. The definition of standard NDN selectors is described in [NDN Selectors Doc](http://named-data.net/doc/ndn-tlv/interest.html#selectors). The concrete definitions of both standard NDN selectors and repo command selectors are the same.
87
88
The difference between standard NDN interest and Repo Deletion Command interest that, the standard NDN selectors just matches **one** data packet that conforms to the selector conditions, but repo command selectors would matches **any** data packets. For example, if Interest is expressed for /ndn/edu and Exclude specifies one name component ucla, in standard NDN interest, the data producers will first exclude all the data packets with prefix /ndn/edu but not /ndn/edu/ucla, and then just selects one data packet. In repo deletion command interest, it will select all the data packets with prefix /ndn/edu but not /ndn/edu/ucla. However, in repo insert command, the repo will fetch one data just like standard interest selectors.
89
90
Repo command supports parts of standard NDN interests including MinSuffixComponents, MaxSuffixComponents, PublisherPublicKeyLocator, and Exclude. ChildSelector is supported in insertion command but not deletion command. If command contains other selectors, repo will ignore these not supported selectors. In addition, selectors are just supported in delete command. If other commands contains selectors, repo will ignore selectors when processing these commands.
91
92
The form of selectors is as follows:
93
94
    Selectors             ::= SELECTORS-TYPE TLV-LENGTH
95
                               MinSuffixComponents?
96
                               MaxSuffixComponents?
97
                               PublisherPublicKeyLocator?
98
                               Exclude?
99
                               ChildSelector?
100
    
101
    MinSuffixComponents   ::= MIN-SUFFIX-COMPONENTS-TYPE TLV-LENGTH
102
                               nonNegativeInteger
103
104
    MaxSuffixComponents   ::= MAX-SUFFIX-COMPONENTS-TYPE TLV-LENGTH
105
                               nonNegativeInteger
106
107
    PublisherPublicKeyLocator ::= KeyLocator
108
    
109
    Exclude               ::= EXCLUDE-TYPE TLV-LENGTH Any? (NameComponent (Any)?)+
110
    Any                   ::= ANY-TYPE TLV-LENGTH(=0)
111
112
    ChildSelector         ::= CHILD-SELECTOR-TYPE TLV-LENGTH
113
                               nonNegativeInteger
114
115
#### StartBlockId, EndBlockId
116
117
StartBlockId and EndBlockId are used to process segmented data. StartBlockId indicate the first segment number and EndBlockId indicate the last segment number. Repo will process segment data whose segment id between StartBlockId and EndBlockId. If StartBlockId is missing, the first segment id the repo process is 0; If EndBlockId is missing, this scenario is described in specific process in Repo Insertion Command section and Repo Deletion Command section.
118
119
#### Conflict of Selectors and StartBlockId, EndBlockId
120
121
Repo cannot process command with both selectors and StartBlockId, EndBlockId in RepoCommandParameter. If the RepoCommandParameter carries both, repo will ignore this command interest and return with error code of 405.
122
123
#### ProcessId
124
125
ProcessId is used by insertion and deletion check command to indicate specific insertion and deletion process. The ProcessId is fetched by repo command response of insertion and deletion command.
126
127
## Repo Command Response
128
129
Repo command response is the response data packet of repo command interest. The response contains statuscode to indicate the status of command process and other information. A TLV-encoded block called ``RepoCommandResponse`` is encoded in content of the data packet.
130
131
    RepoCommandResponse   ::= INSERTSTATUS-TYPE TLV-LENGTH
132
                               ProcessId?
133
                               StatusCode
134
                               StartBlockId?
135
                               EndBlockId?
136
                               InsertNum?
137
                               DeleteNum?
138
139
    ProcessId            ::= PROCESSID-TYPE TLV-LENGTH
140
                                nonNegativeInteger 
141
    
142
    StatusCode            ::= STATUSCODE-TYPE TLV-LENGTH
143
                                nonNegativeInteger    
144
145
    StartBlockId          ::= STARTBLOCKID-TYPE TLV-LENGTH
146
                                nonNegativeInteger
147
    
148
    EndBlockId            ::= ENDBLOCKID-TYPE TLV-LENGTH
149
                                nonNegativeInteger
150
151
    InsertNum             ::= INSERTNUM-TYPE TLV-LENGTH
152
                                nonNegativeInteger
153
154
    DeleteNum             ::= DELETENUM-TYPE TLV-LENGTH
155
                                nonNegativeInteger
156
157
### Name
158
Name indicates the Name in repocommandparameter of repo command
159
160
161
### ProcessId
162
ProcessId is a random number generated by repo to indicate the number of the command process. Client could use this ProcessId to check the status of specific command.
163
164
### StatusCode
165
166
StatusCode indicates the status of repo command process. The statuscodes of insert and deletion command are described in following insertion and deletion specification.
167
168
### StartBlockId, EndBlockId
169
170
StartBlockId and EndBlockId are the same as those of RepoCommandParameter. If either of those in RepoCommandParameter is missing, repo will set them as the Id known for now. For example, if StartBlockId is missing in RepoCommandParameter, StartBlockId in response will be set 0. If EndBlockId is missing in RepoCommandParameter, EndBlockId will be set null untill Repo get FinalBlockId in data packet. If FinalBlockId in returned data packet is less than EndBlockId, the EndBlockId will be set FinalBlockId.
171
172
### InsertNum, DeleteNum
173
InsertNum is used in reponse of insertion status check to indicate how many data packets have been successfully inserted into the repo. DeleteNum is used in response of deletion command and deletion check command. DeleteNum indicates how many data packets have been successfully inserted from repo.
174
175
## Repo TLV Type Encoding Number
176
177
Type                  | Number
178
----------------------| -------
179
RepoCommandParameter  | 201
180
StartBlockId          | 204
181
EndBlockId            | 205
182
ProcessId             | 206
183
RepoCommandResponse   | 207
184
StatusCode            | 208
185
InsertNum             | 209
186
DeleteNum             | 210
187
188
## Repo Trust Model
189
190
The trust model of repo depends on people who deploy the repo service, such as PKI. Repo can specify their own verification policies, and data consumers can specify their own trust anchors. The NDN [FAQ](http://named-data.net/project/faq/#How_does_NDN8217s_8220trust_management8221_work) shows how NDN trust managment works.