Project

General

Profile

Repo Command » History » Version 8

Haitao Zhang, 02/14/2018 01:59 PM

1 2 weijia yuan
Repo Command
2 1 weijia yuan
=============================
3 3 weijia yuan
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 8 Haitao Zhang
33
34 5 weijia yuan
   RepoCommandParameter ::= REPOCOMMANDPARAMETER-TYPE TLV-LENGTH
35 7 Haitao Zhang
                                                    Name?
36
                                                    StartBlockId?
37
                                                    EndBlockId?
38
                                                    ProcessId?
39
                                                    MaxInterestNum?
40
                                                    WatchTimeout?
41
                                                    WatchStatus?
42 3 weijia yuan
                                                    InterestLifetime?
43
44
    Name                  ::= NAME-TYPE TLV-LENGTH NameComponent*
45
    NameComponent         ::= NAME-COMPONENT-TYPE TLV-LENGTH BYTE+
46
47
    StartBlockId          ::= STARTBLOCKID-TYPE TLV-LENGTH
48
                               nonNegativeInteger
49
    
50
    EndBlockId            ::= ENDBLOCKID-TYPE TLV-LENGTH
51
                               nonNegativeInteger
52
53
    ProcessId             ::= PROCESSID-TYPE TLV-LENGTH
54
                               nonNegativeInteger
55
56
    MaxInterestNum        ::= MAX-INTEREST-NUM-TYPE TLV-LENGTH
57
                               nonNegativeInteger
58
59
    WatchTimeout          ::= WATCH-TIMEOUT-TYPE TLV-LENGTH
60
                               nonNegativeInteger
61
62
    WatchStatus           ::= WATCH-STATUS-TYPE TLV-LENGTH
63
                               nonNegativeInteger
64
65
    InterestLifetime      ::= INTEREST-LIFETIME-TYPE TLV-LENGTH
66
                               nonNegativeInteger
67
68
#### StartBlockId, EndBlockId
69
70
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.
71
72
#### ProcessId
73
74
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.
75
76
#### InterestLifetime
77
78
InterestLifetime is the maximum latency between interest sent and data received. If no data received after the InterestLifetime, the interest will time out. InterestLifetime is optional and a default value will be set if it is not specified.
79
80
#### MaxInterestNum
81
82
MaxInterestNum is used by watched prefix insertion protocol to set the upper limit of the total number of interests to be sent.
83
84
#### WatchTimeout
85
86
WatchTimeout is used by watched prefix insertion protocol to set the time duration of the whole watching process.
87
88
#### WatchStatus
89
90
WatchStatus is used by watched prefix insertion protocol to indicate the status of watching process. If the WatchStatus is true, then the watching prefix is running, otherwise, it is not.
91
92
## Repo Command Response
93
94
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.
95
96
    RepoCommandResponse   ::= INSERTSTATUS-TYPE TLV-LENGTH
97
                               ProcessId?
98
                               StatusCode
99
                               StartBlockId?
100
                               EndBlockId?
101
                               InsertNum?
102
                               DeleteNum?
103
104
    ProcessId            ::= PROCESSID-TYPE TLV-LENGTH
105
                                nonNegativeInteger 
106
    
107
    StatusCode            ::= STATUSCODE-TYPE TLV-LENGTH
108
                                nonNegativeInteger    
109
110
    StartBlockId          ::= STARTBLOCKID-TYPE TLV-LENGTH
111
                                nonNegativeInteger
112
    
113
    EndBlockId            ::= ENDBLOCKID-TYPE TLV-LENGTH
114
                                nonNegativeInteger
115
116
    InsertNum             ::= INSERTNUM-TYPE TLV-LENGTH
117
                                nonNegativeInteger
118
119
    DeleteNum             ::= DELETENUM-TYPE TLV-LENGTH
120
                                nonNegativeInteger
121
122
### Name
123
Name indicates the Name in repocommandparameter of repo command
124
125
126
### ProcessId
127
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.
128
129
### StatusCode
130
131
StatusCode indicates the status of repo command process. The statuscodes of insert and deletion command are described in following insertion and deletion specification.
132
133
### StartBlockId, EndBlockId
134
135
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.
136
137
### InsertNum, DeleteNum
138
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 deleted from repo.
139
140
## Repo TLV Type Encoding Number
141
142
Type                  | Number
143
----------------------| -------
144
RepoCommandParameter  | 201
145
StartBlockId          | 204
146
EndBlockId            | 205
147
ProcessId             | 206
148
RepoCommandResponse   | 207
149
StatusCode            | 208
150
InsertNum             | 209
151
DeleteNum             | 210
152
MaxInterestNum        | 211
153
WatchTimeout          | 212
154
WatchStatus           | 213
155
InterestLifetime      | 214
156
157
## Repo Trust Model
158
159
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.