Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
blacksheeep committed Nov 17, 2013
1 parent 7fb627f commit 3f035ed
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions doc/ccnl_crypto_system.txt
Expand Up @@ -26,7 +26,7 @@ CCNL has a build-in system for verification and signatures.
This system is based on OpenSSL and runs in a seperate userspace tool.
The relay communicates with a unix socket with the Crypto-Server.
The entire communication between the relay and the Crypto-Server runs
asynchronously, so that the relay can handle other packets while waiting on
asynchronously, so that the relay can handle other packets while waiting for
the reply msg of the Crypto server.

//----------------------------------------------------------------------------
Expand All @@ -51,19 +51,19 @@ You can imagine the communication between the relay and the Crypto-Server as fol
|


The procedure is the same for verification.
The procedure is the same for the verification.

//----------------------------------------------------------------------------

When the relay call sign or verify and returns from the current operation.
It specify a function that should be called when the reply msg is received.
After the relay calls sign or verify it returns from the current operation.
It specifies a function that should be called when the reply msg is received.
This function will continue the pending operation.
To handle multiple signature/verification operation at the same time, the
user can specify a sequence number when calling the sign/debug operation.

//----------------------------------------------------------------------------

Format of the sign request is the following:
The format of the sign request is the following:

<interest>
<name>
Expand Down Expand Up @@ -157,7 +157,7 @@ int ccnl_crypto_verify(struct ccnl_relay_s *ccnl, char *content, int content_len

After the function call the system should return from the current operation.

Next step is to create a callback function in the file "ccnl-ext-crypto.c" which continues the the pending operation.
Next step is to create a callback function in the file "ccnl-ext-crypto.c" which continues the pending operation.
To allow the system to call the new callback function one has to extend the "ccnl_crypto" function:

if(!strcmp(callback, "ccnl_mgmt_crypto"))
Expand Down
6 changes: 3 additions & 3 deletions doc/ccnl_mgmt_packet_structure.txt
Expand Up @@ -23,7 +23,7 @@
//----------------------------------------------------------------------------

A mgmt-command is send as interest to the relay.
If a interest has the prefix "/ccnx//<command>" the relay recognize it
If a interest has the prefix "/ccnx//<command>" the relay recognizes it
as a mgmt command.


Expand All @@ -44,7 +44,7 @@ All CCN-Lite interests have a similar structure:
</interest>

where "COMMAND" is the mgmt command and
"COMMAND PARAMETER" contains the parameter for the command (delivered in ccn-style formate).
"COMMAND PARAMETER" contains the parameters for the command (delivered in ccn-style formate).
The signature field is optional (only required if content is ship via udp).
The signature is computed over all 4 components.

Expand Down Expand Up @@ -103,7 +103,7 @@ The keep the mgmt system consistent with the CCNx system the first segment of re
msg is send immediately as answer to the mgmt interest.

In CCNx a user must interest in each segment. So for the mgmt system.
If the first reply do not contain the "last segment" tag, the user has to
If the first reply does not contain the "last segment" tag, the user has to
send another interest to get the next segment. To serve the following interest
the relay puts the other segments into the cache.
The prefixes of the segments are: /mgmt/seqnum-1, /mgmt/seqnum-2....
Expand Down

0 comments on commit 3f035ed

Please sign in to comment.