diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/handbook/chapters/developer.texi | 179 | ||||
-rw-r--r-- | doc/handbook/chapters/installation.texi | 4 | ||||
-rw-r--r-- | doc/man/gnunet-gns.1 | 2 | ||||
-rw-r--r-- | doc/man/gnunet-testbed-profiler.1 | 2 | ||||
-rw-r--r-- | doc/man/gnunet-timeout.1 | 2 | ||||
-rw-r--r-- | doc/man/gnunet.conf.5.in | 10 | ||||
-rw-r--r-- | doc/release_policy.rfc.txt | 16 | ||||
-rw-r--r-- | doc/system_specific/FROM_SOURCE | 6 |
8 files changed, 110 insertions, 111 deletions
diff --git a/doc/handbook/chapters/developer.texi b/doc/handbook/chapters/developer.texi index 1bf7a7b24..7546f7ac7 100644 --- a/doc/handbook/chapters/developer.texi +++ b/doc/handbook/chapters/developer.texi | |||
@@ -8885,7 +8885,7 @@ block is more recent during the store operation. | |||
8885 | 8885 | ||
8886 | 8886 | ||
8887 | The REVOCATION subsystem is responsible for key revocation of Egos. | 8887 | The REVOCATION subsystem is responsible for key revocation of Egos. |
8888 | If a user learns that theis private key has been compromised or has lost | 8888 | If a user learns that their private key has been compromised or has lost |
8889 | it, they can use the REVOCATION system to inform all of the other users | 8889 | it, they can use the REVOCATION system to inform all of the other users |
8890 | that their private key is no longer valid. | 8890 | that their private key is no longer valid. |
8891 | The subsystem thus includes ways to query for the validity of keys and to | 8891 | The subsystem thus includes ways to query for the validity of keys and to |
@@ -9782,61 +9782,61 @@ attempt to retransmit them. | |||
9782 | @node MESSENGER Subsystem | 9782 | @node MESSENGER Subsystem |
9783 | @section MESSENGER Subsystem | 9783 | @section MESSENGER Subsystem |
9784 | 9784 | ||
9785 | The MESSENGER subsystem is responsible for secure end-to-end communication in | 9785 | The MESSENGER subsystem is responsible for secure end-to-end communication in |
9786 | groups of nodes in the GNUnet overlay network. MESSENGER builds on the CADET | 9786 | groups of nodes in the GNUnet overlay network. MESSENGER builds on the CADET |
9787 | subsystem which provides a reliable and secure end-to-end communication between | 9787 | subsystem which provides a reliable and secure end-to-end communication between |
9788 | the nodes inside of these groups. | 9788 | the nodes inside of these groups. |
9789 | 9789 | ||
9790 | Additionally to the CADET security benefits, MESSENGER provides following | 9790 | Additionally to the CADET security benefits, MESSENGER provides following |
9791 | properties designed for application level usage: | 9791 | properties designed for application level usage: |
9792 | 9792 | ||
9793 | @itemize @bullet | 9793 | @itemize @bullet |
9794 | @item MESSENGER provides integrity by signing the messages with the users | 9794 | @item MESSENGER provides integrity by signing the messages with the users |
9795 | provided ego | 9795 | provided ego |
9796 | @item MESSENGER adds (optional) forward secrecy by replacing the key pair of the | 9796 | @item MESSENGER adds (optional) forward secrecy by replacing the key pair of the |
9797 | used ego and signing the propagation of the new one with old one (chaining | 9797 | used ego and signing the propagation of the new one with old one (chaining |
9798 | egos) | 9798 | egos) |
9799 | @item MESSENGER provides verification of a original sender by checking against | 9799 | @item MESSENGER provides verification of a original sender by checking against |
9800 | all used egos from a member which are currently in active use (active use | 9800 | all used egos from a member which are currently in active use (active use |
9801 | depends on the state of a member session) | 9801 | depends on the state of a member session) |
9802 | @item MESSENGER offsers (optional) decentralized message forwarding between all | 9802 | @item MESSENGER offsers (optional) decentralized message forwarding between all |
9803 | nodes in a group to improve availability and prevent MITM-attacks | 9803 | nodes in a group to improve availability and prevent MITM-attacks |
9804 | @item MESSENGER handles new connections and disconnections from nodes in the | 9804 | @item MESSENGER handles new connections and disconnections from nodes in the |
9805 | group by reconnecting them preserving an efficient structure for message | 9805 | group by reconnecting them preserving an efficient structure for message |
9806 | distribution (ensuring availability and accountablity) | 9806 | distribution (ensuring availability and accountablity) |
9807 | @item MESSENGER provides replay protection (messages can be uniquely identified | 9807 | @item MESSENGER provides replay protection (messages can be uniquely identified |
9808 | via SHA-512, include a timestamp and the hash of the last message) | 9808 | via SHA-512, include a timestamp and the hash of the last message) |
9809 | @item MESSENGER allows detection for dropped messages by chaining them (messages | 9809 | @item MESSENGER allows detection for dropped messages by chaining them (messages |
9810 | refer to the last message by their hash) improving accountability | 9810 | refer to the last message by their hash) improving accountability |
9811 | @item MESSENGER allows requesting messages from other peers explicitly to ensure | 9811 | @item MESSENGER allows requesting messages from other peers explicitly to ensure |
9812 | availability | 9812 | availability |
9813 | @item MESSENGER provides confidentiality by padding messages to few different | 9813 | @item MESSENGER provides confidentiality by padding messages to few different |
9814 | sizes (512 bytes, 4096 bytes, 32768 bytes and maximal message size from | 9814 | sizes (512 bytes, 4096 bytes, 32768 bytes and maximal message size from |
9815 | CADET) | 9815 | CADET) |
9816 | @item MESSENGER adds (optional) confidentiality with ECDHE to exchange and use | 9816 | @item MESSENGER adds (optional) confidentiality with ECDHE to exchange and use |
9817 | symmetric encryption, encrypting with both AES-256 and Twofish but | 9817 | symmetric encryption, encrypting with both AES-256 and Twofish but |
9818 | allowing only selected members to decrypt (using the receivers ego for | 9818 | allowing only selected members to decrypt (using the receivers ego for |
9819 | ECDHE) | 9819 | ECDHE) |
9820 | @end itemize | 9820 | @end itemize |
9821 | 9821 | ||
9822 | Also MESSENGER provides multiple features with privacy in mind: | 9822 | Also MESSENGER provides multiple features with privacy in mind: |
9823 | 9823 | ||
9824 | @itemize @bullet | 9824 | @itemize @bullet |
9825 | @item MESSENGER allows deleting messages from all peers in the group by the | 9825 | @item MESSENGER allows deleting messages from all peers in the group by the |
9826 | original sender (uses the MESSENGER provided verification) | 9826 | original sender (uses the MESSENGER provided verification) |
9827 | @item MESSENGER allows using the publicly known anonymous ego instead of any | 9827 | @item MESSENGER allows using the publicly known anonymous ego instead of any |
9828 | unique identifying ego | 9828 | unique identifying ego |
9829 | @item MESSENGER allows your node to decide between acting as host of the used | 9829 | @item MESSENGER allows your node to decide between acting as host of the used |
9830 | messaging room (sharing your peer's identity with all nodes in the group) | 9830 | messaging room (sharing your peer's identity with all nodes in the group) |
9831 | or acting as guest (sharing your peer's identity only with the nodes you | 9831 | or acting as guest (sharing your peer's identity only with the nodes you |
9832 | explicitly open a connection to) | 9832 | explicitly open a connection to) |
9833 | @item MESSENGER handles members independently of the peer's identity making | 9833 | @item MESSENGER handles members independently of the peer's identity making |
9834 | forwarded messages indistinguishable from directly received ones ( | 9834 | forwarded messages indistinguishable from directly received ones ( |
9835 | complicating the tracking of messages and identifying its origin) | 9835 | complicating the tracking of messages and identifying its origin) |
9836 | @item MESSENGER allows names of members being not unique (also names are | 9836 | @item MESSENGER allows names of members being not unique (also names are |
9837 | optional) | 9837 | optional) |
9838 | @item MESSENGER does not include information about the selected receiver of an | 9838 | @item MESSENGER does not include information about the selected receiver of an |
9839 | explicitly encrypted message in its header, complicating it for other | 9839 | explicitly encrypted message in its header, complicating it for other |
9840 | members to draw conclusions from communication partners | 9840 | members to draw conclusions from communication partners |
9841 | @end itemize | 9841 | @end itemize |
9842 | 9842 | ||
@@ -9848,71 +9848,71 @@ Also MESSENGER provides multiple features with privacy in mind: | |||
9848 | @node libgnunetmessenger | 9848 | @node libgnunetmessenger |
9849 | @subsection libgnunetmessenger | 9849 | @subsection libgnunetmessenger |
9850 | 9850 | ||
9851 | The MESSENGER API (defined in @file{gnunet_messenger_service.h}) allows P2P | 9851 | The MESSENGER API (defined in @file{gnunet_messenger_service.h}) allows P2P |
9852 | applications built using GNUnet to communicate with specified kinds of messages | 9852 | applications built using GNUnet to communicate with specified kinds of messages |
9853 | in a group. It provides applications the ability to send and receive encrypted | 9853 | in a group. It provides applications the ability to send and receive encrypted |
9854 | messages to any group of peers participating in GNUnet in a decentralized way ( | 9854 | messages to any group of peers participating in GNUnet in a decentralized way ( |
9855 | without even knowing all peers's identities). | 9855 | without even knowing all peers's identities). |
9856 | 9856 | ||
9857 | MESSENGER delivers messages to other peers in "rooms". A room uses a variable | 9857 | MESSENGER delivers messages to other peers in "rooms". A room uses a variable |
9858 | amount of CADET "channels" which will all be used for message distribution. Each | 9858 | amount of CADET "channels" which will all be used for message distribution. Each |
9859 | channel can represent an outgoing connection opened by entering a room with | 9859 | channel can represent an outgoing connection opened by entering a room with |
9860 | @code{GNUNET_MESSENGER_enter_room} or an incoming connection if the room was | 9860 | @code{GNUNET_MESSENGER_enter_room} or an incoming connection if the room was |
9861 | opened before via @code{GNUNET_MESSENGER_open_room}. | 9861 | opened before via @code{GNUNET_MESSENGER_open_room}. |
9862 | 9862 | ||
9863 | @image{images/messenger_room,6in,,Room structure} | 9863 | @image{images/messenger_room,6in,,Room structure} |
9864 | 9864 | ||
9865 | To enter a room you have to specify the "door" (peer's identity of a peer which | 9865 | To enter a room you have to specify the "door" (peer's identity of a peer which |
9866 | has opened the room) and the key of the room (which is identical to a CADET | 9866 | has opened the room) and the key of the room (which is identical to a CADET |
9867 | "port"). To open a room you have to specify only the key to use. When opening a | 9867 | "port"). To open a room you have to specify only the key to use. When opening a |
9868 | room you automatically distribute a PEER-message sharing your peer's identity in | 9868 | room you automatically distribute a PEER-message sharing your peer's identity in |
9869 | the room. | 9869 | the room. |
9870 | 9870 | ||
9871 | Entering or opening a room can also be combined in any order. In any case you | 9871 | Entering or opening a room can also be combined in any order. In any case you |
9872 | will automatically get a unique member ID and send a JOIN-message notifying | 9872 | will automatically get a unique member ID and send a JOIN-message notifying |
9873 | others about your entry and your public key from your selected ego. | 9873 | others about your entry and your public key from your selected ego. |
9874 | 9874 | ||
9875 | The ego can be selected by name with the initial @code{GNUNET_MESSENGER_connect} | 9875 | The ego can be selected by name with the initial @code{GNUNET_MESSENGER_connect} |
9876 | besides setting a (identity-)callback for each change/confirmation of the used | 9876 | besides setting a (identity-)callback for each change/confirmation of the used |
9877 | ego and a (message-)callback which gets called every time a message gets sent or | 9877 | ego and a (message-)callback which gets called every time a message gets sent or |
9878 | received in the room. Once the identity-callback got called you can check your | 9878 | received in the room. Once the identity-callback got called you can check your |
9879 | used ego with @code{GNUNET_MESSENGER_get_key} providing only its public key. The | 9879 | used ego with @code{GNUNET_MESSENGER_get_key} providing only its public key. The |
9880 | function returns NULL if the anonymous ego is used. If the ego should be | 9880 | function returns NULL if the anonymous ego is used. If the ego should be |
9881 | replaced with a newly generated one, you can use @code{GNUNET_MESSENGER_update} | 9881 | replaced with a newly generated one, you can use @code{GNUNET_MESSENGER_update} |
9882 | to ensure proper chaining of used egos. | 9882 | to ensure proper chaining of used egos. |
9883 | 9883 | ||
9884 | Also once the identity-callback got called you can check your used name with | 9884 | Also once the identity-callback got called you can check your used name with |
9885 | @code{GNUNET_MESSENGER_get_name} and potentially change or set a name via | 9885 | @code{GNUNET_MESSENGER_get_name} and potentially change or set a name via |
9886 | @code{GNUNET_MESSENGER_set_name}. A name is for example required to create a new | 9886 | @code{GNUNET_MESSENGER_set_name}. A name is for example required to create a new |
9887 | ego with @code{GNUNET_MESSENGER_update}. Also any change in ego or name will | 9887 | ego with @code{GNUNET_MESSENGER_update}. Also any change in ego or name will |
9888 | automatically be distributed in the room with a NAME- or KEY-message | 9888 | automatically be distributed in the room with a NAME- or KEY-message |
9889 | respectively. | 9889 | respectively. |
9890 | 9890 | ||
9891 | To send a message a message inside of a room you can use | 9891 | To send a message a message inside of a room you can use |
9892 | @code{GNUNET_MESSENGER_send_message}. If you specify a selected contact as | 9892 | @code{GNUNET_MESSENGER_send_message}. If you specify a selected contact as |
9893 | receiver, the message gets encrypted automatically and will be sent as PRIVATE- | 9893 | receiver, the message gets encrypted automatically and will be sent as PRIVATE- |
9894 | message instead. | 9894 | message instead. |
9895 | 9895 | ||
9896 | To request a potentially missed message or to get a specific message after its | 9896 | To request a potentially missed message or to get a specific message after its |
9897 | original call of the message-callback, you can use | 9897 | original call of the message-callback, you can use |
9898 | @code{GNUNET_MESSENGER_get_message}. Additionally once a message was distributed | 9898 | @code{GNUNET_MESSENGER_get_message}. Additionally once a message was distributed |
9899 | to application level and the message-callback got called, you can get the | 9899 | to application level and the message-callback got called, you can get the |
9900 | contact respresenting a message's sender respectively with | 9900 | contact respresenting a message's sender respectively with |
9901 | @code{GNUNET_MESSENGER_get_sender}. This allows getting name and the public key | 9901 | @code{GNUNET_MESSENGER_get_sender}. This allows getting name and the public key |
9902 | of any sender currently in use with @code{GNUNET_MESSENGER_contact_get_name} | 9902 | of any sender currently in use with @code{GNUNET_MESSENGER_contact_get_name} |
9903 | and @code{GNUNET_MESSENGER_contact_get_key}. It is also possible to iterate | 9903 | and @code{GNUNET_MESSENGER_contact_get_key}. It is also possible to iterate |
9904 | through all current members of a room with | 9904 | through all current members of a room with |
9905 | @code{GNUNET_MESSENGER_iterate_members} using a callback. | 9905 | @code{GNUNET_MESSENGER_iterate_members} using a callback. |
9906 | 9906 | ||
9907 | To leave a room you can use @code{GNUNET_MESSENGER_close_room} which will also | 9907 | To leave a room you can use @code{GNUNET_MESSENGER_close_room} which will also |
9908 | close the rooms connections once all applications on the same peer have left | 9908 | close the rooms connections once all applications on the same peer have left |
9909 | the room. Leaving a room will also send a LEAVE-message closing a member session | 9909 | the room. Leaving a room will also send a LEAVE-message closing a member session |
9910 | on all connected peers before any connection will be closed. Leaving a room is | 9910 | on all connected peers before any connection will be closed. Leaving a room is |
9911 | however not required for any application to keep your member session open | 9911 | however not required for any application to keep your member session open |
9912 | between multiple sessions of the actual application. | 9912 | between multiple sessions of the actual application. |
9913 | 9913 | ||
9914 | Finally, when an application no longer wants to use CADET, it should call | 9914 | Finally, when an application no longer wants to use CADET, it should call |
9915 | @code{GNUNET_MESSENGER_disconnect}. You don't have to explicitly close the used | 9915 | @code{GNUNET_MESSENGER_disconnect}. You don't have to explicitly close the used |
9916 | rooms or leave them. | 9916 | rooms or leave them. |
9917 | 9917 | ||
9918 | Here is a little summary to the kinds of messages you can send manually: | 9918 | Here is a little summary to the kinds of messages you can send manually: |
@@ -9928,33 +9928,33 @@ Here is a little summary to the kinds of messages you can send manually: | |||
9928 | @node MERGE-message | 9928 | @node MERGE-message |
9929 | @subsubsection MERGE-message | 9929 | @subsubsection MERGE-message |
9930 | 9930 | ||
9931 | MERGE-messages will generally be sent automatically to reduce the amount of | 9931 | MERGE-messages will generally be sent automatically to reduce the amount of |
9932 | parallel chained messages. This is necessary to close a member session for | 9932 | parallel chained messages. This is necessary to close a member session for |
9933 | example. You can also send MERGE-messages manually if required to merge two | 9933 | example. You can also send MERGE-messages manually if required to merge two |
9934 | chains of messages. | 9934 | chains of messages. |
9935 | 9935 | ||
9936 | @node INVITE-message | 9936 | @node INVITE-message |
9937 | @subsubsection INVITE-message | 9937 | @subsubsection INVITE-message |
9938 | 9938 | ||
9939 | INVITE-messages can be used to invite other members in a room to a different | 9939 | INVITE-messages can be used to invite other members in a room to a different |
9940 | room, sharing one potential door and the required key to enter the room. This | 9940 | room, sharing one potential door and the required key to enter the room. This |
9941 | kind of message is typically sent as encrypted PRIVATE-message to selected | 9941 | kind of message is typically sent as encrypted PRIVATE-message to selected |
9942 | members because it doesn't make much sense to invite all members from one room | 9942 | members because it doesn't make much sense to invite all members from one room |
9943 | to another considering a rooms key doesn't specify its usage. | 9943 | to another considering a rooms key doesn't specify its usage. |
9944 | 9944 | ||
9945 | @node TEXT-message | 9945 | @node TEXT-message |
9946 | @subsubsection TEXT-message | 9946 | @subsubsection TEXT-message |
9947 | 9947 | ||
9948 | TEXT-messages can be used to send simple text-based messages and should be | 9948 | TEXT-messages can be used to send simple text-based messages and should be |
9949 | considered as being in readable form without complex decoding. The text has to | 9949 | considered as being in readable form without complex decoding. The text has to |
9950 | end with a NULL-terminator character and should be in UTF-8 encoding for most | 9950 | end with a NULL-terminator character and should be in UTF-8 encoding for most |
9951 | compatibility. | 9951 | compatibility. |
9952 | 9952 | ||
9953 | @node FILE-message | 9953 | @node FILE-message |
9954 | @subsubsection FILE-message | 9954 | @subsubsection FILE-message |
9955 | 9955 | ||
9956 | FILE-messages can be used to share files inside of a room. They do not contain | 9956 | FILE-messages can be used to share files inside of a room. They do not contain |
9957 | the actual file being shared but its original hash, filename, URI to download | 9957 | the actual file being shared but its original hash, filename, URI to download |
9958 | the file and a symmetric key to decrypt the downloaded file. | 9958 | the file and a symmetric key to decrypt the downloaded file. |
9959 | 9959 | ||
9960 | It is recommended to use the FS subsystem and the FILE-messages in combination. | 9960 | It is recommended to use the FS subsystem and the FILE-messages in combination. |
@@ -9962,30 +9962,29 @@ It is recommended to use the FS subsystem and the FILE-messages in combination. | |||
9962 | @node DELETE-message | 9962 | @node DELETE-message |
9963 | @subsubsection DELETE-message | 9963 | @subsubsection DELETE-message |
9964 | 9964 | ||
9965 | DELETE-messages can be used to delete messages selected with its hash. You can | 9965 | DELETE-messages can be used to delete messages selected with its hash. You can |
9966 | also select any custom delay relative to the time of sending the DELETE-message. | 9966 | also select any custom delay relative to the time of sending the DELETE-message. |
9967 | Deletion will only be processed on each peer in a room if the sender is | 9967 | Deletion will only be processed on each peer in a room if the sender is |
9968 | authorized. | 9968 | authorized. |
9969 | 9969 | ||
9970 | The only information of a deleted message which being kept will be the chained | 9970 | The only information of a deleted message which being kept will be the chained |
9971 | hashes connecting the message graph for potential traversion. For example the | 9971 | hashes connecting the message graph for potential traversion. For example the |
9972 | check for completion of a member session requires this information. | 9972 | check for completion of a member session requires this information. |
9973 | 9973 | ||
9974 | @node Member sessions | 9974 | @node Member sessions |
9975 | @subsection Member sessions | 9975 | @subsection Member sessions |
9976 | 9976 | ||
9977 | A member session is a triple of the room key, the member ID and the public key | 9977 | A member session is a triple of the room key, the member ID and the public key |
9978 | of the member's ego. Member sessions allow that a member can change their ID or | 9978 | of the member's ego. Member sessions allow that a member can change their ID or |
9979 | their ego once at a time without losing the ability to delete old messages or | 9979 | their ego once at a time without losing the ability to delete old messages or |
9980 | identifying the original sender of a message. On every change of ID or EGO a | 9980 | identifying the original sender of a message. On every change of ID or EGO a |
9981 | session will be marked as closed. So every session chain will only contain one | 9981 | session will be marked as closed. So every session chain will only contain one |
9982 | open session with the current ID and public key. | 9982 | open session with the current ID and public key. |
9983 | 9983 | ||
9984 | If a session is marked as closed the MESSENGER service will check from the first | 9984 | If a session is marked as closed the MESSENGER service will check from the first |
9985 | message opening a session to its last one closing the session for completion. If | 9985 | message opening a session to its last one closing the session for completion. If |
9986 | a the service can confirm that there is no message still missing which was sent | 9986 | a the service can confirm that there is no message still missing which was sent |
9987 | from the closed member session, it will be marked as completed. | 9987 | from the closed member session, it will be marked as completed. |
9988 | 9988 | ||
9989 | A completed member session is not able to verify any incoming message to ensure | 9989 | A completed member session is not able to verify any incoming message to ensure |
9990 | forward secrecy preventing others from using old stolen egos. | 9990 | forward secrecy preventing others from using old stolen egos. |
9991 | |||
diff --git a/doc/handbook/chapters/installation.texi b/doc/handbook/chapters/installation.texi index 24431e20f..54fb3f486 100644 --- a/doc/handbook/chapters/installation.texi +++ b/doc/handbook/chapters/installation.texi | |||
@@ -1533,7 +1533,7 @@ Now restart your webserver and your peer... | |||
1533 | @subsection Blacklisting peers | 1533 | @subsection Blacklisting peers |
1534 | 1534 | ||
1535 | Transport service supports to deny connecting to a specific peer of to a | 1535 | Transport service supports to deny connecting to a specific peer of to a |
1536 | specific peer with a specific transport plugin using te blacklisting | 1536 | specific peer with a specific transport plugin using the blacklisting |
1537 | component of transport service. With@ blacklisting it is possible to deny | 1537 | component of transport service. With@ blacklisting it is possible to deny |
1538 | connections to specific peers of@ to use a specific plugin to a specific | 1538 | connections to specific peers of@ to use a specific plugin to a specific |
1539 | peer. Peers can be blacklisted using@ the configuration or a blacklist | 1539 | peer. Peers can be blacklisted using@ the configuration or a blacklist |
@@ -1560,7 +1560,7 @@ To blacklist connections to P565... on peer AG2P... using all plugins add: | |||
1560 | P565723JO1C2HSN6J29TAQ22MN6CI8HTMUU55T0FUQG4CMDGGEQ8UCNBKUMB94GC8R9G4FB2SF9LDOBAJ6AMINBP4JHHDD6L7VD801G = | 1560 | P565723JO1C2HSN6J29TAQ22MN6CI8HTMUU55T0FUQG4CMDGGEQ8UCNBKUMB94GC8R9G4FB2SF9LDOBAJ6AMINBP4JHHDD6L7VD801G = |
1561 | @end example | 1561 | @end example |
1562 | 1562 | ||
1563 | You can also add a blacklist client usign the blacklist API. On a | 1563 | You can also add a blacklist client using the blacklist API. On a |
1564 | blacklist check, blacklisting first checks internally if the peer is | 1564 | blacklist check, blacklisting first checks internally if the peer is |
1565 | blacklisted and if not, it asks the blacklisting clients. Clients are | 1565 | blacklisted and if not, it asks the blacklisting clients. Clients are |
1566 | asked if it is OK to connect to a peer ID, the plugin is omitted. | 1566 | asked if it is OK to connect to a peer ID, the plugin is omitted. |
diff --git a/doc/man/gnunet-gns.1 b/doc/man/gnunet-gns.1 index 5595981b0..de48369f5 100644 --- a/doc/man/gnunet-gns.1 +++ b/doc/man/gnunet-gns.1 | |||
@@ -64,7 +64,7 @@ Resolve the specified name using the GNU Name System. | |||
64 | .It Fl T Ar TIMEOUT | Fl -timeout= Ns Ar TIMEOUT | 64 | .It Fl T Ar TIMEOUT | Fl -timeout= Ns Ar TIMEOUT |
65 | How much time to wait for a resolution to finish. | 65 | How much time to wait for a resolution to finish. |
66 | Example: "5s" for 5 seconds or "3m" for 3 minutes. | 66 | Example: "5s" for 5 seconds or "3m" for 3 minutes. |
67 | Defaults to "forver" (No timeout). | 67 | Defaults to "forever" (No timeout). |
68 | .It Fl v | -version | 68 | .It Fl v | -version |
69 | Print GNUnet version number. | 69 | Print GNUnet version number. |
70 | .El | 70 | .El |
diff --git a/doc/man/gnunet-testbed-profiler.1 b/doc/man/gnunet-testbed-profiler.1 index b39544641..d079609ad 100644 --- a/doc/man/gnunet-testbed-profiler.1 +++ b/doc/man/gnunet-testbed-profiler.1 | |||
@@ -46,7 +46,7 @@ is a command line profiling driver for the testbed. | |||
46 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 46 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
47 | Use the configuration file FILENAME. | 47 | Use the configuration file FILENAME. |
48 | .It Fl e Ar COUNT | Fl -num-errors= Ns Ar COUNT | 48 | .It Fl e Ar COUNT | Fl -num-errors= Ns Ar COUNT |
49 | Tolerate COUNT number of continious timeout failures. | 49 | Tolerate COUNT number of continuous timeout failures. |
50 | .It Fl H Ar FILENAME | Fl -hosts= Ns Ar FILENAME | 50 | .It Fl H Ar FILENAME | Fl -hosts= Ns Ar FILENAME |
51 | Name of the file with the login information for the testbed. | 51 | Name of the file with the login information for the testbed. |
52 | .It Fl h | -help | 52 | .It Fl h | -help |
diff --git a/doc/man/gnunet-timeout.1 b/doc/man/gnunet-timeout.1 index a36141c36..85ecc88c1 100644 --- a/doc/man/gnunet-timeout.1 +++ b/doc/man/gnunet-timeout.1 | |||
@@ -35,7 +35,7 @@ | |||
35 | .Sh DESCRIPTION | 35 | .Sh DESCRIPTION |
36 | .Nm | 36 | .Nm |
37 | can be used to run another process with a timeout. | 37 | can be used to run another process with a timeout. |
38 | It is provided because the standard "timout" utility may not be available on all platforms. | 38 | It is provided because the standard "timeout" utility may not be available on all platforms. |
39 | .Sh SEE ALSO | 39 | .Sh SEE ALSO |
40 | .Xr timeout 1 | 40 | .Xr timeout 1 |
41 | .sp | 41 | .sp |
diff --git a/doc/man/gnunet.conf.5.in b/doc/man/gnunet.conf.5.in index 116e7de3b..19136b849 100644 --- a/doc/man/gnunet.conf.5.in +++ b/doc/man/gnunet.conf.5.in | |||
@@ -54,7 +54,7 @@ encountered. | |||
54 | .It | 54 | .It |
55 | A section contains a number of options of the form "OPTION=VALUE". | 55 | A section contains a number of options of the form "OPTION=VALUE". |
56 | .It | 56 | .It |
57 | Whitespace surounding the "=" token is striped out, in other words | 57 | Whitespace surrounding the "=" token is striped out, in other words |
58 | "OPTION = VALUE" and "OPTION=VALUE" are treated equal. | 58 | "OPTION = VALUE" and "OPTION=VALUE" are treated equal. |
59 | .It | 59 | .It |
60 | Empty lines and lines beginning with a "#" are treated as comments. | 60 | Empty lines and lines beginning with a "#" are treated as comments. |
@@ -166,7 +166,7 @@ Set to NO if this is a system service. | |||
166 | In the following sections the absence of a default value is either | 166 | In the following sections the absence of a default value is either |
167 | expressed as "Default value:" followed by nothing, or the lack of this line. | 167 | expressed as "Default value:" followed by nothing, or the lack of this line. |
168 | .Ss ARM | 168 | .Ss ARM |
169 | .Bl -tag -width indent | 169 | .Bl -tag -width indent |
170 | .It PORT | 170 | .It PORT |
171 | Default value: 2087 | 171 | Default value: 2087 |
172 | .It HOSTNAME | 172 | .It HOSTNAME |
@@ -215,7 +215,7 @@ options differ. | |||
215 | If set to YES, ARM will only start services that are marked as per-user | 215 | If set to YES, ARM will only start services that are marked as per-user |
216 | services (and we'll expect a system user to run ARM to provide system-level | 216 | services (and we'll expect a system user to run ARM to provide system-level |
217 | services). | 217 | services). |
218 | Per-user services enable better personalization and priviledge separation and | 218 | Per-user services enable better personalization and privilege separation and |
219 | in particular ensures that personal data is stored under $HOME, which might be | 219 | in particular ensures that personal data is stored under $HOME, which might be |
220 | important in a multi-user system (or if $HOME is encrypted and | 220 | important in a multi-user system (or if $HOME is encrypted and |
221 | .Pa /var/ | 221 | .Pa /var/ |
@@ -321,7 +321,7 @@ Default value: 2.00 | |||
321 | .It 1.0 | 321 | .It 1.0 |
322 | Fair with respect to addresses without preferences. | 322 | Fair with respect to addresses without preferences. |
323 | .It > 1.0 | 323 | .It > 1.0 |
324 | The bigger, the more respect is payed to preferences. | 324 | The bigger, the more respect is paid to preferences. |
325 | .El | 325 | .El |
326 | .It PROP_STABILITY_FACTOR | 326 | .It PROP_STABILITY_FACTOR |
327 | Should we stick to existing connections are prefer to switch? | 327 | Should we stick to existing connections are prefer to switch? |
@@ -430,7 +430,7 @@ Default value: 5 min | |||
430 | Percentage of packets CADET is artificially dropping. | 430 | Percentage of packets CADET is artificially dropping. |
431 | Used for testing only! | 431 | Used for testing only! |
432 | .It ID_ANNOUNCE_TIME | 432 | .It ID_ANNOUNCE_TIME |
433 | How frequently do we usually anounce our presence in the DHT? | 433 | How frequently do we usually announce our presence in the DHT? |
434 | .Pp | 434 | .Pp |
435 | Default value: 1 h | 435 | Default value: 1 h |
436 | .It CONNECT_TIMEOUT | 436 | .It CONNECT_TIMEOUT |
diff --git a/doc/release_policy.rfc.txt b/doc/release_policy.rfc.txt index 41c98ec93..e13e72f43 100644 --- a/doc/release_policy.rfc.txt +++ b/doc/release_policy.rfc.txt | |||
@@ -7,17 +7,17 @@ social process in order to find a decision in a cooperativ and common | |||
7 | way. | 7 | way. |
8 | 8 | ||
9 | 9 | ||
10 | I. Driver | 10 | I. Driver |
11 | ========= | 11 | ========= |
12 | (What is the problem and what solution did we find?) | 12 | (What is the problem and what solution did we find?) |
13 | 13 | ||
14 | In the past it was sometimes unclear when and how the community would reach its | 14 | In the past it was sometimes unclear when and how the community would reach its |
15 | next release. Members were lacking in orientation and felt demotivated. | 15 | next release. Members were lacking in orientation and felt demotivated. |
16 | 16 | ||
17 | Another minor concern not yet analysed in depth was the expectation to show the | 17 | Another minor concern not yet analysed in depth was the expectation to show the |
18 | public that the GNUnet project is still active and making progress. With an old | 18 | public that the GNUnet project is still active and making progress. With an old |
19 | release distributed by popular linux distributions it was hard to showcase | 19 | release distributed by popular linux distributions it was hard to showcase |
20 | people the GNUnet features and encourage to participate in the project. | 20 | people the GNUnet features and encourage to participate in the project. |
21 | 21 | ||
22 | To show people how the GNUnet project is releasing its software we hereby | 22 | To show people how the GNUnet project is releasing its software we hereby |
23 | document the current release model: | 23 | document the current release model: |
@@ -55,7 +55,7 @@ document the current release model: | |||
55 | 55 | ||
56 | For further information see: https://trunkbaseddevelopment.com/ | 56 | For further information see: https://trunkbaseddevelopment.com/ |
57 | 57 | ||
58 | II. Evaluation Criteria | 58 | II. Evaluation Criteria |
59 | ======================= | 59 | ======================= |
60 | (what are criteria to interpret the results as success if we review | 60 | (what are criteria to interpret the results as success if we review |
61 | the problem and solution after a year or so) | 61 | the problem and solution after a year or so) |
@@ -74,7 +74,7 @@ code. I don't have a magic bullet to motivate you to write more tests, | |||
74 | or to improve existing tests. -CG | 74 | or to improve existing tests. -CG |
75 | 75 | ||
76 | Your argument is good. Two or three of us thought that the problem is about | 76 | Your argument is good. Two or three of us thought that the problem is about |
77 | missing releases which we feld demotivating. We thought, we were stuck | 77 | missing releases which we felt demotivating. We thought, we were stuck |
78 | somewhere. But as you state, it is us not doing the necessary work. What I | 78 | somewhere. But as you state, it is us not doing the necessary work. What I |
79 | still find useful is to document the release process. In consequence I | 79 | still find useful is to document the release process. In consequence I |
80 | changed the problem statement. -xrs | 80 | changed the problem statement. -xrs |
@@ -106,7 +106,7 @@ for improving that situation). -CG | |||
106 | With resprect to changes kept in branches the reason why I personally keep | 106 | With resprect to changes kept in branches the reason why I personally keep |
107 | changes back is because it takes very long for me to get something really | 107 | changes back is because it takes very long for me to get something really |
108 | working in C. Before that I either not worth it or I don't want to blame | 108 | working in C. Before that I either not worth it or I don't want to blame |
109 | other before not being sure it's not my fault. | 109 | other before not being sure it's not my fault. |
110 | 110 | ||
111 | Can we track branches? Can we write a little cronjob that checks for branches | 111 | Can we track branches? Can we write a little cronjob that checks for branches |
112 | that are to long undercover with the aim to recommend the responsible person | 112 | that are to long undercover with the aim to recommend the responsible person |
@@ -137,7 +137,7 @@ rewrites are happening, it is important to minimize the number of | |||
137 | branches. -CG | 137 | branches. -CG |
138 | 138 | ||
139 | Thank you for clarifying. I added the API aspect above. -xrs | 139 | Thank you for clarifying. I added the API aspect above. -xrs |
140 | 140 | ||
141 | 141 | ||
142 | IV. Doing | 142 | IV. Doing |
143 | ========= | 143 | ========= |
@@ -153,7 +153,7 @@ Let me list what I think needs doing: | |||
153 | 2) A culture of fixing "other people"'s bugs: test case failures, | 153 | 2) A culture of fixing "other people"'s bugs: test case failures, |
154 | portability issues, Mantis reports, all the non-sexy | 154 | portability issues, Mantis reports, all the non-sexy |
155 | stuff. Not the 'psycstore' was written by tg, so no | 155 | stuff. Not the 'psycstore' was written by tg, so no |
156 | need for !tg to try to fix it, or the "I use sqlite, | 156 | need for !tg to try to fix it, or the "I use sqlite, |
157 | why should I bother with postgres?"-crap I have heard | 157 | why should I bother with postgres?"-crap I have heard |
158 | too often. | 158 | too often. |
159 | 3) Improving test cases: better code coverage, more corner | 159 | 3) Improving test cases: better code coverage, more corner |
diff --git a/doc/system_specific/FROM_SOURCE b/doc/system_specific/FROM_SOURCE index 7b0ebf436..2e98ab5c0 100644 --- a/doc/system_specific/FROM_SOURCE +++ b/doc/system_specific/FROM_SOURCE | |||
@@ -204,7 +204,7 @@ $ gnunet-arm -s | |||
204 | @subsection Install the GNUnet-gtk user interface from Git | 204 | @subsection Install the GNUnet-gtk user interface from Git |
205 | 205 | ||
206 | 206 | ||
207 | Install depencies: | 207 | Install dependencies: |
208 | 208 | ||
209 | @example | 209 | @example |
210 | $ sudo apt-get install libgtk-3-dev libunique-3.0-dev libgladeui-dev \ | 210 | $ sudo apt-get install libgtk-3-dev libunique-3.0-dev libgladeui-dev \ |
@@ -866,7 +866,7 @@ This means that you have to make sure the proper tools are used in the build pro | |||
866 | For example, after installing texinfo you need to make sure the new texinfo is actually used: | 866 | For example, after installing texinfo you need to make sure the new texinfo is actually used: |
867 | 867 | ||
868 | @example | 868 | @example |
869 | $ echo 'export PATH="/usr/local/opt/texinfo/bin:$PATH"' >> ~/.bash_profile | 869 | $ echo 'export PATH="/usr/local/opt/texinfo/bin:$PATH"' >> ~/.bash_profile |
870 | @end example | 870 | @end example |
871 | 871 | ||
872 | Note: brew tells you the appropriate command when executing | 872 | Note: brew tells you the appropriate command when executing |
@@ -886,7 +886,7 @@ $ export CC=gcc-7 | |||
886 | 886 | ||
887 | You might see configure failing telling you that it ``cannot run C compiled programs.''. | 887 | You might see configure failing telling you that it ``cannot run C compiled programs.''. |
888 | In this case, you might need to open/run Xcode once and you will be prompted to | 888 | In this case, you might need to open/run Xcode once and you will be prompted to |
889 | install additonal packages. | 889 | install additional packages. |
890 | Then, you might have to manually install the command line tools from here https://developer.apple.com/download/more/ (you need an Apple ID for this). | 890 | Then, you might have to manually install the command line tools from here https://developer.apple.com/download/more/ (you need an Apple ID for this). |
891 | Install those and execute | 891 | Install those and execute |
892 | 892 | ||