Project

General

Profile

NLSR Management » History » Version 36

Muktadir Chowdhury, 10/06/2017 11:06 AM

1 1 Muktadir Chowdhury
NLSR Management
2
===============
3 2 Muktadir Chowdhury
4
NLSR Management provides:
5
6
- command to add(advertise) routes to name prefix list
7 21 Muktadir Chowdhury
- command to remove(withdraw) routes from name prefix list
8 2 Muktadir Chowdhury
9 3 Muktadir Chowdhury
## 1. Control Commands
10 2 Muktadir Chowdhury
11 19 Muktadir Chowdhury
### 1.1 Add a name prefix
12 10 Muktadir Chowdhury
13 19 Muktadir Chowdhury
#### command-verb: advertise
14 10 Muktadir Chowdhury
This command adds a name prefix to the name prefix list. This command can be accepted on ```ndn:/localhost/nlsr/prefix-update``` prefix.
15 2 Muktadir Chowdhury
16 19 Muktadir Chowdhury
#### Control Parameters
17 2 Muktadir Chowdhury
- Name (required)
18
19 19 Muktadir Chowdhury
### 1.2 Remove a name prefix
20 11 Muktadir Chowdhury
21 19 Muktadir Chowdhury
#### command-verb: withdraw
22 11 Muktadir Chowdhury
This command removes a name prefix from the name prefix list. This command can be accepted on ```ndn:/localhost/nlsr/prefix-update``` prefix.
23
24 19 Muktadir Chowdhury
#### Control Parameters
25 2 Muktadir Chowdhury
- Name (required)
26
27 3 Muktadir Chowdhury
## 2. Request format
28 36 Muktadir Chowdhury
NLSR control commands are command interests (https://redmine.named-data.net/projects/ndn-cxx/wiki/CommandInterest), whose name has the following form: 
29 1 Muktadir Chowdhury
30 36 Muktadir Chowdhury
```/<prefix>/<management-module>/<command-verb>/<control-parameters>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>```
31
                                                                                                                            \                                                /\                                                     /
32
                                                                                                                              -------------  -------------------   ---------------   --------------------
33
                                                                                                                                                \/                                                  \/
34
                                                                                                                             Command Interest Extension     Components of Signed Interest
35
36 13 Muktadir Chowdhury
- ```<prefix>``` is ```/localhost/nlsr ```. Each individual command may specify additional prefixes under which that command could be accepted.
37
- ```<management-module> ```is the name of management module to which the command needs to be dispatched. For example, the name of the management module in this case would be ```prefix-update```.
38 1 Muktadir Chowdhury
- ```<command-verb>``` is the command to be executed. For this case this would be either ```withdraw``` or ```advertise```.
39 35 Muktadir Chowdhury
- ```<control-parameters>``` is a ControlParameters TLV block wrapped in a NameComponent.
40 1 Muktadir Chowdhury
- ```<timestamp>``` is interest's timestamp that  is used to prevent replay attack.
41 35 Muktadir Chowdhury
- ```<random-value>``` aka Nonce that ensures the uniqueness of an interest.
42 36 Muktadir Chowdhury
- ```<SignatureInfo>``` and ```<SignatureValue>``` are additional components defined by [ndn-cxx:SignedInterest|Signed Interest] spec.
43 13 Muktadir Chowdhury
So, putting everything together, the complete name of a command interest would be ```localhost/nlsr/prefix-update/advertise``` or ```localhost/nlsr/prefix-update/withdraw```
44 2 Muktadir Chowdhury
45 6 Muktadir Chowdhury
## 3. Response Format
46 1 Muktadir Chowdhury
47 2 Muktadir Chowdhury
A response from the command interface is a Data that matches the request Interest. The payload of this Data is a ControlResponse block.
48
49 1 Muktadir Chowdhury
### StatusCode
50 32 Ashlesh Gawande
StatusCode loosely follows the HTTP semantics described in RFC2616 section 10 ([RFC2616](https://www.ietf.org/rfc/rfc2616.txt))
51 6 Muktadir Chowdhury
52 3 Muktadir Chowdhury
StatusCode  |	Description
53
------------|------------------------------------
54 2 Muktadir Chowdhury
200         |		OK
55 22 Laqin Fan
204         | Prefix is already advertised/withdrawn
56 2 Muktadir Chowdhury
400	    | ControlParameters is incorrect
57
403	    | Command Interest is not authorized
58
501	    | Module or verb is not supported
59 1 Muktadir Chowdhury
503         | Feature is disabled