summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2013-04-10 01:37:23 +0200
committermathieui <mathieui@mathieui.net>2013-04-10 01:37:23 +0200
commitbf8e2a942c884a4a35e297734ce6c098849ac086 (patch)
treeca1744be21ba7f0532c8850f3cf9fc4a445c87d2 /doc/source
parent1ec613b95ce33d9768f61ab1eff58a0522907cbf (diff)
downloadpoezio-bf8e2a942c884a4a35e297734ce6c098849ac086.tar.gz
poezio-bf8e2a942c884a4a35e297734ce6c098849ac086.tar.bz2
poezio-bf8e2a942c884a4a35e297734ce6c098849ac086.tar.xz
poezio-bf8e2a942c884a4a35e297734ce6c098849ac086.zip
Move images, and add SSL page
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/images/conversation.pngbin0 -> 9649 bytes
-rw-r--r--doc/source/images/correct.pngbin0 -> 632 bytes
-rw-r--r--doc/source/images/data_forms.pngbin0 -> 6522 bytes
-rw-r--r--doc/source/images/layers.pngbin0 -> 15642 bytes
-rw-r--r--doc/source/images/list.pngbin0 -> 5795 bytes
-rw-r--r--doc/source/images/muc.pngbin0 -> 17818 bytes
-rw-r--r--doc/source/images/private.pngbin0 -> 6645 bytes
-rw-r--r--doc/source/images/roster.pngbin0 -> 11280 bytes
-rw-r--r--doc/source/images/simple_notify_example.pngbin0 -> 5536 bytes
-rw-r--r--doc/source/images/ssl_warning.pngbin0 -> 881 bytes
-rw-r--r--doc/source/images/tab_bar.pngbin0 -> 712 bytes
-rw-r--r--doc/source/images/theme_256_colors.pngbin0 -> 37316 bytes
-rw-r--r--doc/source/images/vert_tabs.pngbin0 -> 2890 bytes
-rw-r--r--doc/source/index.rst1
-rw-r--r--doc/source/misc/index.rst22
-rw-r--r--doc/source/misc/ssl.rst60
-rw-r--r--doc/source/themes.rst2
17 files changed, 84 insertions, 1 deletions
diff --git a/doc/source/images/conversation.png b/doc/source/images/conversation.png
new file mode 100644
index 00000000..0940a3a4
--- /dev/null
+++ b/doc/source/images/conversation.png
Binary files differ
diff --git a/doc/source/images/correct.png b/doc/source/images/correct.png
new file mode 100644
index 00000000..ed2ad450
--- /dev/null
+++ b/doc/source/images/correct.png
Binary files differ
diff --git a/doc/source/images/data_forms.png b/doc/source/images/data_forms.png
new file mode 100644
index 00000000..0afb3e03
--- /dev/null
+++ b/doc/source/images/data_forms.png
Binary files differ
diff --git a/doc/source/images/layers.png b/doc/source/images/layers.png
new file mode 100644
index 00000000..9ec71521
--- /dev/null
+++ b/doc/source/images/layers.png
Binary files differ
diff --git a/doc/source/images/list.png b/doc/source/images/list.png
new file mode 100644
index 00000000..a2fc2315
--- /dev/null
+++ b/doc/source/images/list.png
Binary files differ
diff --git a/doc/source/images/muc.png b/doc/source/images/muc.png
new file mode 100644
index 00000000..8ddfff10
--- /dev/null
+++ b/doc/source/images/muc.png
Binary files differ
diff --git a/doc/source/images/private.png b/doc/source/images/private.png
new file mode 100644
index 00000000..19492e2b
--- /dev/null
+++ b/doc/source/images/private.png
Binary files differ
diff --git a/doc/source/images/roster.png b/doc/source/images/roster.png
new file mode 100644
index 00000000..d1a8f9f4
--- /dev/null
+++ b/doc/source/images/roster.png
Binary files differ
diff --git a/doc/source/images/simple_notify_example.png b/doc/source/images/simple_notify_example.png
new file mode 100644
index 00000000..2e9c617c
--- /dev/null
+++ b/doc/source/images/simple_notify_example.png
Binary files differ
diff --git a/doc/source/images/ssl_warning.png b/doc/source/images/ssl_warning.png
new file mode 100644
index 00000000..348a81a4
--- /dev/null
+++ b/doc/source/images/ssl_warning.png
Binary files differ
diff --git a/doc/source/images/tab_bar.png b/doc/source/images/tab_bar.png
new file mode 100644
index 00000000..9c5c74eb
--- /dev/null
+++ b/doc/source/images/tab_bar.png
Binary files differ
diff --git a/doc/source/images/theme_256_colors.png b/doc/source/images/theme_256_colors.png
new file mode 100644
index 00000000..395f3d39
--- /dev/null
+++ b/doc/source/images/theme_256_colors.png
Binary files differ
diff --git a/doc/source/images/vert_tabs.png b/doc/source/images/vert_tabs.png
new file mode 100644
index 00000000..a48a8051
--- /dev/null
+++ b/doc/source/images/vert_tabs.png
Binary files differ
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 8ec26348..ea744b26 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -15,6 +15,7 @@ Contents:
themes
commands
dev/index
+ misc/index
..
configure
diff --git a/doc/source/misc/index.rst b/doc/source/misc/index.rst
new file mode 100644
index 00000000..bf8fcb90
--- /dev/null
+++ b/doc/source/misc/index.rst
@@ -0,0 +1,22 @@
+Miscellaneous topics
+====================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ ssl
+
+
+..
+ configure
+ ssl
+ usage
+ themes
+ keys
+ plugins
+ misc
+ xep
+ dev
+
diff --git a/doc/source/misc/ssl.rst b/doc/source/misc/ssl.rst
new file mode 100644
index 00000000..a012ebed
--- /dev/null
+++ b/doc/source/misc/ssl.rst
@@ -0,0 +1,60 @@
+SSL Management
+==============
+
+Starting from version 0.7.5, poezio offers some options to check the validity
+of a X.509 certificate.
+
+TOFU
+----
+
+The default handling method is the `TOFU/TUFU`_
+method. At your first connection, poezio will save the hash of the certificate
+received, and will compare the received one and the first one for the next
+connections.
+
+
+If you are paranoid (or run poezio for the first time in an unsafe
+environment), you can set the _certificate_ value of your config file yourself
+(the hash, not colon-separated).
+
+
+If the certificate is not the same, poezio will show an error message and wait
+for confirmation:
+
+.. figure:: ../images/ssl_warning.png
+ :alt: Warning message
+
+If you press y, the change is validated an poezio will match the next certs
+with the accepted one.
+
+If you press n, you will get the confirmation that the change has been
+refused, and you will be disconnected.
+
+CA-Based
+--------
+
+If you are connecting to a large server that has several front-facing
+endpoints, you might be bothered by having to validate the change each time,
+and you may want to check only if it the same authority delivered the
+certificate.
+
+You can then set the *ca_cert_path* option to the path of a file containing
+the validation chain in `PEM format`_ ; those certificates are usually in
+/usr/share/ca-certificates/ but it may vary depending of your distribution.
+
+
+If the authority does not match when connecting, you should be disconnected.
+
+None
+----
+
+If you do not want to bother with certificate validation at all (which can be
+the case when you run poezio on the same computer as your jabber server), you
+can set the *ignore_certificate* value to true, and let the *ca_cert_path*
+option empty (or even remove it).
+
+.. warning:: Only do this if you know what you are doing, or you will be open
+ to Man in The Middle attacks!
+
+.. _TOFU/TUFU: https://en.wikipedia.org/wiki/User:Dotdotike/Trust_Upon_First_Use
+.. _PEM format: https://tools.ietf.org/html/rfc1422.html
diff --git a/doc/source/themes.rst b/doc/source/themes.rst
index 92b88245..2a12d8c4 100644
--- a/doc/source/themes.rst
+++ b/doc/source/themes.rst
@@ -69,7 +69,7 @@ text white on black by default, a fg_color of -1 is white, and a bg_color
of -1 is black). If it’s between 0 and 256 it represents one of the colors
on the image:
-.. figure:: ../images/theme_256_colors.png
+.. figure:: ./images/theme_256_colors.png
:alt: The list of all 256 colors
The list of all 256 colors