diff --git a/doc/EN/usage.org b/doc/EN/usage.org index ff723ddb..e960e026 100644 --- a/doc/EN/usage.org +++ b/doc/EN/usage.org @@ -191,22 +191,153 @@ ssh myusername@mydomain -p 2222 #+END_SRC Then select *IRC* from the menu. Irssi is automatically set up to connect to your server and route its messages through the Tor network. Some popular systems such as *Freenode* reject connections coming from Tor (as a very crude attempt to stop trolls) and so if you want to use those you can exit to the command line from the menu and then just type "irssi" to use the system without Tor. + +To connect manually: + +#+BEGIN_SRC bash +irssi +/server add -auto -ssl yourdomainname 6697 +/connect yourdomainname +/join #freedombone +/save +#+END_SRC *** XChat -If you are using the XChat client: +First install xchat and set up its configuration file. + +#+BEGIN_SRC bash +sudo apt-get install tor xchat +mkdir ~/.xchat2 +echo "# By default, XChat based IRC software, when started-up, or run for first time, +# it starts to use local network, to connect to the internet. To prevent that, +# and to force it, to use Tor proxy (a Socks5 server): +# +# /set net_proxy_host 127.0.0.1 +# /set net_proxy_port 9050 +# /set net_proxy_type 3 +# /set net_proxy_use 0 +net_proxy_host = 127.0.0.1 +net_proxy_port = 9050 +# Technical note: 3 = socks5 +net_proxy_type = 3 +# Technical note: Do not worry. 0 is not equal to "off". 0 stands for "All". +# Check yourself https://toxin.jottit.com/xchat_set_variables +net_proxy_use = 0 + +# XChat should not use the same circuit/exit server as other Tor applications. +# Otherwise activity in different applications could be correlated to the same +# pseudonym. There is a way to prevent that. +# It is called stream isolation. We use IsolateSOCKSAuth, +# see https://www.torproject.org/docs/tor-manual-dev.html.en +# The password is actually not required, but it does not hurt either. +# Will probable not hurt on Tor 0.2.2 and below. +# Works with Tor 0.2.3 and above. +# +# /set net_proxy_auth 1 +# /set net_proxy_pass = XChat +# /set net_proxy_user = XChat +# +net_proxy_auth = 1 +net_proxy_pass = XChat +net_proxy_user = XChat + +# Get rid of protocol leaks: +# a DCC session can reveal IP address, etc. identd flag can reveal your +# username which you use to login in your OS(Windows/Linux/Unix/MacOS) profile. +# To prevent those: +# +# /set dcc_auto_chat 0 +# /set dcc_auto_resume OFF +# /set dcc_auto_send 0 +# /set irc_hide_version ON +# /set identd OFF <-- NOT working on all XChat-based IRC software. +# But still highly suggested to include & use it. +# Probable not needed on UNIX, source: http://xchat.org/faq/#q21 +dcc_auto_chat = 0 +dcc_auto_resume = 0 +dcc_auto_send = 0 +irc_hide_version = 1 +identd = 0 + +# If you use your own comment instead of default values, then these data are +# posted on each channel when you do these events: JOIN, PART, QUIT, AWAY. +# So they can reveal who you actually are, when you are using same XChat +# software for multiple different nicknames. +# +# Delete everything under Settings -> Preferences -> Default Messages: +# -> Quit: +# -> Leave channel: +# -> Away: +away_reason = +irc_part_reason = +irc_quit_reason = + +# By default, XChat based IRC software uses your platform OS(Operating System)s +# login user name as your nickname, user name, real name. To prevent leaking +# that, and, to use your own choice of nickname, realname, username: +# +# ***Pseudonymous vs. anonymous IRC use.*** +# Actually IRC is pseudonymous. Your nickname might also reveal something about +# your origin, interests, etc. You can make IRC more anonymous by choosing a more +# meaningless nickname. Use the following defaults if you want to be more anonymous. +# If user, user_ and user___ are already taken, add more _ or start using user1, +# user2, user3, etc. Or if the irc network auto assigns your a nickname, i.e. +# guest532, stick with that nickname. +# +# Of course, you are free to continue using IRC in a pseudonymous manner. +# In that case, instant of user, choose your nickname. +# +# /set irc_real_name user +# /set irc_user_name user +# /set irc_nick1 user +# /set irc_nick2 user_ +# /set irc_nick3 user__ +irc_real_name = user +irc_user_name = user +irc_nick1 = user +irc_nick2 = user_ +irc_nick3 = user__ + +# Use a more common nick completion suffix: +# When you write the first few characters of a nickname followed by tab, +# it will, by XChat default, complete the nickname and ", " behind the +# nickname. The behavior is XChat specific. The " :" is more more common +# for more common clients such as mIRC. +# +# XChat -> Settings -> Preferences -> input box -> completion_suffix set to : +# +completion_suffix = : + +# Not starting the server windows at the beginning so you can check and set +# settings before connecting to any IRC networks. +gui_slist_skip = 1 +" > ~/.xchat2/xchat.conf +#+END_SRC + +Now look up the onion address for your IRC server + +#+BEGIN_SRC bash +ssh username@mydomainname -p 2222 +#+END_SRC + +Select Administrator options, then *About this system* and make a note of the onion address for IRC. Also select the *IRC Menu* and take a note of the login password. + +[[file:images/xchat_setup.jpg]] + +Run XChat. Within the network list click, *Add* and enter your domain name then click *Edit*. -Select the entry within the servers box, then enter *mydomainname/6697* and press *Enter*. +Select the entry within the servers box, then enter *ircaddress.onion/6697* and press *Enter*. Uncheck *use global user information*. Enter first and second nicknames and check *auto connect to this network on startup*. -Check *use SSL* and *accept invalid SSL certificate*. +Make sure that *use SSL* is unchecked. Encryption will be handled via the onion address itself. Enter *#freedombone* as the channel name. -Enter the password which can be found from the IRC menu of the *control panel*. +Within the *Server password* field enter the password which can be found from the IRC menu of the *control panel*. Click *close* and then *connect*. diff --git a/img/xchat_setup.jpg b/img/xchat_setup.jpg new file mode 100644 index 00000000..45d4cac9 Binary files /dev/null and b/img/xchat_setup.jpg differ diff --git a/website/EN/usage.html b/website/EN/usage.html index 9c30962f..8620e6b6 100644 --- a/website/EN/usage.html +++ b/website/EN/usage.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + @@ -170,15 +170,15 @@ for the JavaScript code in this tag. -Readme +Readme -Improving ssh security +Improving ssh security -Administrating the system via an onion address (Tor) +Administrating the system via an onion address (Tor) @@ -190,38 +190,38 @@ for the JavaScript code in this tag. -Syncing to the Cloud +Syncing to the Cloud -Play Music +Play Music -Microblogging (GNU Social) +Microblogging (GNU Social) -Social Network +Social Network -Chat Services +Chat Services -RSS Reader +RSS Reader -Adding or removing users +Adding or removing users -
-

Readme

-
+
+

Readme

+

After the system has installed a README file will be generated which contains passwords and some brief advice on using the installed systems. You can read this with the following commands:

@@ -242,9 +242,9 @@ To exit you can either just close the terminal or use CTRL-x CTRL-c follo

-
-

Improving ssh security

-
+
+

Improving ssh security

+

To improve ssh security you can generate an ssh key pair on your system and then upload the public key to the Freedombone.

@@ -297,9 +297,9 @@ If you wish to only use ssh keys then log in to the Freedombone, become the root
-
-

Administrating the system via an onion address (Tor)

-
+
+

Administrating the system via an onion address (Tor)

+

You can also access your system via the Tor system using an onion address. To find out what the onion address for ssh access is you can do the following:

@@ -328,9 +328,9 @@ Subsequently even if dynamic DNS isn't working you may still be able to administ

-
-

Syncing to the Cloud

-
+
+

Syncing to the Cloud

+

Syncthing provides a similar capability to proprietary systems such as Dropbox, and also is well suited for use with low power single board computers. You can have one or more directories which are synchronized across your various laptops/desktops/devices, and this makes it hard for you to ever lose important files. The manner in which the synchronization is done is pretty secure, such that it would be difficult for passive adversaries (mass surveillance, "men in the middle", etc) to know what files you're sharing. Of course, you don't necessarily need to be running a server in order to use Syncthing, but if you do have a server which is always running then there's always at least one place to synchronize your files to or from.

@@ -340,9 +340,9 @@ Freedombone provides Syncthing shared directories for each user on the system, p

-
-

On a laptop

-
+
+

On a laptop

+

Install syncthing:

@@ -397,9 +397,9 @@ Now wait for a few minutes. Eventually you will see two messages appear within t

-
-

On Android

-
+
+

On Android

+

Install Syncthing and Connectbot from F-droid.

@@ -430,12 +430,12 @@ Now wait for a few minutes or more. Eventually you should receive two notificati
-
-

Play Music

-
-
-

With the DLNA service

-
+
+

Play Music

+
+
+

With the DLNA service

+

An easy way to play music on any mobile device in your home is to use the DLNA service. Copy your music into a directory called "Music" on a USB thumb drive and then insert it into from socket on the Beaglebone.

@@ -476,9 +476,9 @@ The DLNA service will only work within your local home network, and isn't remote
-
-

Microblogging (GNU Social)

-
+
+

Microblogging (GNU Social)

+

To log into your GNU Social site first obtain your username and password from the "microblogging" section of the readme file.

@@ -507,20 +507,20 @@ GNU Social has a clutter-free mobile user interface which can be accessed via a
-
-

Social Network

-
-
-

Domains

-
+
+

Social Network

+
+
+

Domains

+

Both Hubzilla and GNU Social try to obtain certificates automatically at the time of installation via Let's Encrypt. This will likely mean that in order for this to work you'll need to have obtained at least one "official" domain via a domain selling service, since Let's Encrypt mostly doesn't seem to work with free subdomains from sites such as freeDNS.

-
-

Initial install

-
+
+

Initial install

+

On first visiting your Hubzilla site you'll see the login screen. The first thing you need to do is register a new user. The first user on the system then becomes its administrator.

@@ -534,19 +534,19 @@ On first visiting your Hubzilla site you'll see the login screen. The first thin
-
-

Chat Services

-
-
-

IRC

-
+
+

Chat Services

+
+
+

IRC

+

IRC is useful for multi-user chat. The classic use case is for software development where many engineers might need to coordinate their activities, but it's also useful for meetings, parties and general socialising.

-
-

Irssi

-
+
+

Irssi

+

The easiest way to use irssi is to connect to your system, like this:

@@ -560,13 +560,162 @@ The easiest way to use irssi is to connect to your system, like this:

Then select IRC from the menu. Irssi is automatically set up to connect to your server and route its messages through the Tor network. Some popular systems such as Freenode reject connections coming from Tor (as a very crude attempt to stop trolls) and so if you want to use those you can exit to the command line from the menu and then just type "irssi" to use the system without Tor.

-
-
-
-

XChat

-
+

-If you are using the XChat client: +To connect manually: +

+ +
+ +
irssi
+/server add -auto -ssl yourdomainname 6697
+/connect yourdomainname
+/join #freedombone
+/save
+
+
+
+
+
+

XChat

+
+

+First install xchat and set up its configuration file. +

+ +
+ +
sudo apt-get install tor xchat
+mkdir ~/.xchat2
+echo "# By default, XChat based IRC software, when started-up, or run for first time,
+# it starts to use local network, to connect to the internet. To prevent that,
+# and to force it, to use Tor proxy (a Socks5 server):
+#
+# /set net_proxy_host 127.0.0.1
+# /set net_proxy_port 9050
+# /set net_proxy_type 3
+# /set net_proxy_use 0
+net_proxy_host = 127.0.0.1
+net_proxy_port = 9050
+# Technical note: 3 = socks5
+net_proxy_type = 3
+# Technical note: Do not worry. 0 is not equal to "off". 0 stands for "All".
+#                 Check yourself https://toxin.jottit.com/xchat_set_variables
+net_proxy_use = 0
+
+# XChat should not use the same circuit/exit server as other Tor applications.
+# Otherwise activity in different applications could be correlated to the same
+# pseudonym. There is a way to prevent that.
+# It is called stream isolation. We use IsolateSOCKSAuth, 
+# see https://www.torproject.org/docs/tor-manual-dev.html.en
+# The password is actually not required, but it does not hurt either.
+# Will probable not hurt on Tor 0.2.2 and below.
+# Works with Tor 0.2.3 and above.
+#
+# /set net_proxy_auth 1
+# /set net_proxy_pass = XChat
+# /set net_proxy_user = XChat
+#
+net_proxy_auth = 1
+net_proxy_pass = XChat
+net_proxy_user = XChat
+
+# Get rid of protocol leaks:
+# a DCC session can reveal IP address, etc. identd flag can reveal your
+# username which you use to login in your OS(Windows/Linux/Unix/MacOS) profile.
+# To prevent those:
+#
+# /set dcc_auto_chat 0
+# /set dcc_auto_resume OFF
+# /set dcc_auto_send 0
+# /set irc_hide_version ON
+# /set identd OFF <-- NOT working on all XChat-based IRC software.
+# But still highly suggested to include & use it.
+# Probable not needed on UNIX, source: http://xchat.org/faq/#q21 
+dcc_auto_chat = 0
+dcc_auto_resume = 0
+dcc_auto_send = 0
+irc_hide_version = 1
+identd = 0
+
+# If you use your own comment instead of default values, then these data are
+# posted on each channel when you do these events: JOIN, PART, QUIT, AWAY.
+# So they can reveal who you actually are, when you are using same XChat
+# software for multiple different nicknames.
+#
+# Delete everything under Settings -> Preferences -> Default Messages:
+# -> Quit: <Deleted everything!>
+# -> Leave channel: <Deleted everything!>
+# -> Away: <Deleted everything!>
+away_reason = 
+irc_part_reason = 
+irc_quit_reason = 
+
+# By default, XChat based IRC software uses your platform OS(Operating System)s
+# login user name as your nickname, user name, real name.  To prevent leaking
+# that, and, to use your own choice of nickname, realname, username:
+#
+# ***Pseudonymous vs. anonymous IRC use.***
+# Actually IRC is pseudonymous. Your nickname might also reveal something about
+# your origin, interests, etc. You can make IRC more anonymous by choosing a more
+# meaningless nickname. Use the following defaults if you want to be more anonymous.
+# If user, user_ and user___ are already taken, add more _ or start using user1,
+# user2, user3, etc. Or if the irc network auto assigns your a nickname, i.e.
+# guest532, stick with that nickname.
+#
+# Of course, you are free to continue using IRC in a pseudonymous manner.
+# In that case, instant of user, choose your nickname.
+#
+# /set irc_real_name user
+# /set irc_user_name user
+# /set irc_nick1 user
+# /set irc_nick2 user_
+# /set irc_nick3 user__
+irc_real_name = user
+irc_user_name = user
+irc_nick1 = user
+irc_nick2 = user_
+irc_nick3 = user__
+
+# Use a more common nick completion suffix:
+# When you write the first few characters of a nickname followed by tab,
+# it will, by XChat default, complete the nickname and ", " behind the
+# nickname. The behavior is XChat specific. The " :" is more more common
+# for more common clients such as mIRC.
+#
+# XChat -> Settings -> Preferences -> input box -> completion_suffix set to :
+#
+completion_suffix = :
+
+# Not starting the server windows at the beginning so you can check and set
+# settings before connecting to any IRC networks.
+gui_slist_skip = 1
+" > ~/.xchat2/xchat.conf
+
+
+ +

+Now look up the onion address for your IRC server +

+ +
+ +
ssh username@mydomainname -p 2222
+
+
+ +

+Select Administrator options, then About this system and make a note of the onion address for IRC. Also select the IRC Menu and take a note of the login password. +

+ + +
+

xchat_setup.jpg +

+
+ +

+Run XChat.

@@ -574,7 +723,7 @@ Within the network list click, Add and enter your domain name then click

-Select the entry within the servers box, then enter mydomainname/6697 and press Enter. +Select the entry within the servers box, then enter ircaddress.onion/6697 and press Enter.

@@ -586,7 +735,7 @@ Enter first and second nicknames and check auto connect to this network on st

-Check use SSL and accept invalid SSL certificate. +Make sure that use SSL is unchecked. Encryption will be handled via the onion address itself.

@@ -594,7 +743,7 @@ Enter #freedombone as the channel name.

-Enter the password which can be found from the IRC menu of the control panel. +Within the Server password field enter the password which can be found from the IRC menu of the control panel.

@@ -603,9 +752,9 @@ Click close and then connect.

-
-

Changing or removing the IRC password

-
+
+

Changing or removing the IRC password

+

By default the IRC server is set up to require a password for users to log in. The password is the same for all users. If you want to change or remove the password:

@@ -623,12 +772,12 @@ Select Administrator controls then IRC Menu and then change the pa
-
-

XMPP/Jabber

-
-
-

Using with Profanity

-
+
+

XMPP/Jabber

+
+
+

Using with Profanity

+

The Profanity shell based user interface and is perhaps the simplest way to use XMPP from a laptop. It's also a good way to ensure that your OTR keys are the same even when logging in from different laptops or devices, and it also means that if those devices later become compomised then there are no locally stored OTR keys to be found.

@@ -718,9 +867,9 @@ When accessed via the user control panel the client is automatically routed thro

-
-

Using with Jitsi

-
+
+

Using with Jitsi

+

Jitsi is the recommended communications client for desktop or laptop systems, since it includes the off the record (OTR) feature which provides some additional security beyond the usual SSL certificates.

@@ -750,9 +899,9 @@ You can also see this vide

-
-

Using with Ubuntu

-
+
+

Using with Ubuntu

+

The default XMPP client in Ubuntu is Empathy. Using Empathy isn't as secure as using Jitsi, since it doesn't include the off the record feature, but since it's the default it's what many users will have easy access to.

@@ -770,17 +919,17 @@ Click on Advanced and make sure that Encryption required and Ig

-
-

Using Tor Messenger

-
+ -
-

Using with Android

-
+
+

Using with Android

+

Install F-Droid

@@ -816,16 +965,16 @@ Then select Next. When chatting you can use the lock icon to encrypt your
-
-

Tox

-
+
+

Tox

+

Tox is an encrypted peer-to-peer messaging system and so should work without Freedombone. It uses a system of nodes which act as a sort of directory service allowing users to find and connect to each other. The Tox node ID on the Freedombone can be found within the README within your home directory. If you have other users connect to your node then you will be able to continue chatting even when no other nodes are available.

-
-

Using the Toxic client

-
+
+

Using the Toxic client

+

Log into your system with:

@@ -849,12 +998,12 @@ Then from the menu select Tox Chat. Tox is encrypted by default and also
-
-

VoIP (Voice chat)

-
-
-

Using with Ubuntu

-
+
+

VoIP (Voice chat)

+
+
+

Using with Ubuntu

+

Within the software center search for "mumble" and install the client then run it. Skip through the audio setup wizard.

@@ -868,9 +1017,9 @@ Click on "add new" to add a new server and enter the default domain name for the

-
-

Using with Android

-
+
+

Using with Android

+

Install F-Droid

@@ -897,24 +1046,24 @@ Selecting the server by pressing on it then connects you to the server so that y
-
-

SIP phones

-
+
+

SIP phones

+

Freedombone also supports SIP phones The username and domain is the same as for your email address, and the SIP password and extension number will appear within the README file in your home directory. Various SIP client options are available, such as CSipSimple on Android and Jitsi on desktop or laptop machines. Ideally use clients which support ZRTP, which will provide the best level of security.

-
-

About ZRTP

-
+
+

About ZRTP

+

ZRTP appears to be the current best standard to end-to-end encrypted voice calls, combining good security with simplicity of use. When the initial cryptographic negotiation between phones is done at the start of a call a short authentication string (SAS) is calculated and displayed at both ends. To check that there isn't anyone intercepting the call and acting as a man in the middle - as stingray type devices try to do - the short authentication string can be read out and verbally confirmed between the callers. If it's the same then you can be pretty confident that the call is secure.

-
-

Using with CSIPSimple

-
+
+

Using with CSIPSimple

+

Add an account. Under General Wizards choose Expert and enter the following details:

@@ -970,9 +1119,9 @@ If everything is working the account should appear in green with a status of

-
-

Using with Ring

-
+
+

Using with Ring

+

From the menu select Manage accounts.

@@ -1025,9 +1174,9 @@ Select the Security tab. Under SRTP Key Exchange select ZRTP
-
-

RSS Reader

-
+
+

RSS Reader

+

The way that RSS reading is set up on Freedombone gives you strong reading privacy. Not only is there onion routing between you and the server but also between the server and the source of the RSS feed. The only down side is that many RSS feeds are still http only, and so could be vulnerable to injection attacks, but it's expected that more of this will go to https in the foreseeable future due to a combination of growing recognition of security issues and systems like Let's Encrypt which make obtaining certificates much easier.

@@ -1071,9 +1220,9 @@ A note for the paranoid is that on mobile devices you get redirected to a differ
-
-

Adding or removing users

-
+
+

Adding or removing users

+

Log into the system with: