aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-scalarproduct.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-scalarproduct.1')
-rw-r--r--doc/man/gnunet-scalarproduct.140
1 files changed, 31 insertions, 9 deletions
diff --git a/doc/man/gnunet-scalarproduct.1 b/doc/man/gnunet-scalarproduct.1
index 73081e2ed..0159e1eb9 100644
--- a/doc/man/gnunet-scalarproduct.1
+++ b/doc/man/gnunet-scalarproduct.1
@@ -9,7 +9,8 @@ gnunet\-vectorproduct \- compute a vectorproduct
9.br 9.br
10 10
11.SH DESCRIPTION 11.SH DESCRIPTION
12\fBgnunet-vectorproduct\fP enables you to compute a vectorproduct across two peers \fBAlice\fP and \fBBob\fP. 12\fBgnunet-vectorproduct\fP enables you to compute a vectorproduct
13across two peers \fBAlice\fP and \fBBob\fP.
13 14
14A client can issue one of two messages to its service: 15A client can issue one of two messages to its service:
15.TS 16.TS
@@ -23,30 +24,51 @@ Elements to support a peer in computing a vectorproduct (\fBBob\fP)
23T} 24T}
24.TE 25.TE
25 26
26Both requests must share the same SID, which can be an arbitrary string identifying the session. SIDs should be unique, however it is sufficient to guarantee the uniqueness of the tupel element count and session ID. 27Both requests must share the same SID, which can be an arbitrary
28string identifying the session. SIDs should be unique, however it is
29sufficient to guarantee the uniqueness of the tupel element count and
30session ID.
27 31
28\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s service, it will internally be checked by the client for validity. Invalid values here result in the client or the service failing the session. 32\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s
33service, it will internally be checked by the client for
34validity. Invalid values here result in the client or the service
35failing the session.
29 36
30Elements are handed over as signed decimal integers, the element count supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also supply a mask for these values to her service, which allows partial vector products to be computed across the vector. Elements can be masked by setting their the corresponding mask element to zero, any other value means the element will not be masked. \fBAlice\fP\'s client will also mask all 0-values to avoid information leakage to \fBBob\fP. 37Elements are handed over as signed decimal integers, the element count
38supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also
39supply a mask for these values to her service, which allows partial
40vector products to be computed across the vector. Elements can be
41masked by setting their the corresponding mask element to zero, any
42other value means the element will not be masked. \fBAlice\fP\'s
43client will also mask all 0-values to avoid information leakage to
44\fBBob\fP.
31 45
32The protocol by definition relies on \fBAlice\fP and \fBBob\fP being benign, thus \fBBob\fP can arbitrarily falsify his information. Both peers collaborate to achieve a correct result. 46The protocol by definition relies on \fBAlice\fP and \fBBob\fP being
47benign, thus \fBBob\fP can arbitrarily falsify his information. Both
48peers collaborate to achieve a correct result.
33 49
34.SH OPTIONS 50.SH OPTIONS
35.B 51.B
36.IP "\-e ELEMENTS, \-\-elements=ELEMENTS" 52.IP "\-e ELEMENTS, \-\-elements=ELEMENTS"
37The element-vector the vectorproduct should be computed over in signed decimal form, eg: \"42,1,-3,3,7\". Zero value elements will be automatically masked. 53The element-vector the vectorproduct should be computed over in signed
54decimal form, eg: \"42,1,-3,3,7\". Zero value elements will be automatically masked.
38.B 55.B
39.IP "\-m MASK, \-\-mask=MASK" 56.IP "\-m MASK, \-\-mask=MASK"
40Elements in the vector can be masked. There must be at least two elements left in the vector to compute a vectorproduct. Non-Zero values indicate an element is not maskes. 57Elements in the vector can be masked. There must be at least two
58elements left in the vector to compute a vectorproduct. Non-Zero
59values indicate an element is not maskes.
41.B 60.B
42.IP "\-k KEY, \-\-key=KEY" 61.IP "\-k KEY, \-\-key=KEY"
43The session key, a shared string of arbitrary length from which the SID will be generated 62The session key, a shared string of arbitrary length from which the
63SID will be generated
44.B 64.B
45.IP "\-c FILENAME, \-\-config=FILENAME" 65.IP "\-c FILENAME, \-\-config=FILENAME"
46Use the configuration file FILENAME. 66Use the configuration file FILENAME.
47.B 67.B
48.IP "\-p PEERID, \-\-peer=PEERID" 68.IP "\-p PEERID, \-\-peer=PEERID"
49The remote peer\'s ASCII-armored gnunet-peer ID as output by gnunet-peerinfo. If this option is not given, the peer will take the \fBBob\fP\'s role. 69The remote peer\'s ASCII-armored gnunet-peer ID as output by
70gnunet-peerinfo. If this option is not given, the peer will take the
71\fBBob\fP\'s role.
50.B 72.B
51.IP "\-h, \-\-help" 73.IP "\-h, \-\-help"
52Print short help on options. 74Print short help on options.