From 8f442c2aa6fcdef882d2ff0684f896a3807dee01 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Mon, 19 May 2014 16:23:13 -0500 Subject: update manpage --- docs/man/bitmask.1.rst | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) (limited to 'docs') diff --git a/docs/man/bitmask.1.rst b/docs/man/bitmask.1.rst index ed4f7133..28fc945a 100644 --- a/docs/man/bitmask.1.rst +++ b/docs/man/bitmask.1.rst @@ -85,21 +85,16 @@ At the current time, Bitmask is not compatible with ``openresolv``, but it works FILES ===== -/etc/leap/resolv-update ------------------------ -Post up/down script passed to openvpn. It writes /etc/resolv.conf to avoid dns leaks, and restores the original resolv.conf on exit. -/etc/leap/resolv-head ---------------------- -/etc/leap/resolv-tail ---------------------- +/usr/share/polkit-1/actions/se.leap.bitmask.policy +------------------------------------------------------- -Custom entries that will appear in the written resolv.conf +PolicyKit policy file, used for granting access to bitmask-root without the need of entering a password each time. -/usr/share/polkit-1/actions/net.openvpn.gui.leap.policy -------------------------------------------------------- +/usr/sbin/bitmask-root +------------------------ -PolicyKit policy file, used for granting access to openvpn without the need of entering a password each time. +Helper to launch and stop openvpn and the bitmask firewall. ~/.config/leap/ --------------- -- cgit v1.2.3 From 1ef5b43cead587b3962b4d633c5faa658471a912 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Mon, 19 May 2014 16:35:19 -0500 Subject: manpage source for bitmask-root --- docs/man/bitmask-root.1.rst | 54 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 docs/man/bitmask-root.1.rst (limited to 'docs') diff --git a/docs/man/bitmask-root.1.rst b/docs/man/bitmask-root.1.rst new file mode 100644 index 00000000..7ed53aa9 --- /dev/null +++ b/docs/man/bitmask-root.1.rst @@ -0,0 +1,54 @@ +============ +bitmask-root +============ + +------------------------------------------------------------------------ +privileged helper for bitmask, the encrypted internet access toolkit. +------------------------------------------------------------------------ + +:Author: LEAP Encryption Access Project https://leap.se +:Date: 2014-05-19 +:Copyright: GPLv3+ +:Version: 0.5.1 +:Manual section: 1 +:Manual group: General Commands Manual + +SYNOPSIS +======== + +bitmask-root [openvpn | firewall | isup ] [start | stop] [ARGS] + +DESCRIPTION +=========== + +*bitmask-root* is a privileged helper for bitmask. + +It is used to start or stop openvpn and the bitmask firewall. + + +OPTIONS +======= + +openvpn +-------- + +**start** [ARGS] Starts openvpn. All args are passed to openvpn, and + filtered against a list of allowed args. + +**stop** Stops openvpn. + + +firewall +--------- + +**start** [GATEWAYS] Starts the firewall. GATEWAYS is a list of EIP + gateways to allow in the firewall. + +**stop** Stops the firewall. + + + +BUGS +==== + +Please report any bugs to https://leap.se/code -- cgit v1.2.3 From e373a9d071c2c45952e8f7ef68a3471b5e2aa9f5 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Mon, 19 May 2014 16:37:56 -0500 Subject: update bitmask manpage date and version --- docs/man/bitmask.1.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/man/bitmask.1.rst b/docs/man/bitmask.1.rst index 28fc945a..2711d6a0 100644 --- a/docs/man/bitmask.1.rst +++ b/docs/man/bitmask.1.rst @@ -7,9 +7,9 @@ graphical client to control LEAP, the encrypted internet access toolkit. ------------------------------------------------------------------------ :Author: LEAP Encryption Access Project https://leap.se -:Date: 2013-08-23 +:Date: 2014-05-19 :Copyright: GPLv3+ -:Version: 0.3.1 +:Version: 0.5.1 :Manual section: 1 :Manual group: General Commands Manual -- cgit v1.2.3 From 7b9338214dce27676e7e2008bd23e678688aa658 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Tue, 20 May 2014 17:55:30 -0500 Subject: remove reference to openresolv conflict from manpage --- docs/man/bitmask.1.rst | 1 - 1 file changed, 1 deletion(-) (limited to 'docs') diff --git a/docs/man/bitmask.1.rst b/docs/man/bitmask.1.rst index 2711d6a0..38da64af 100644 --- a/docs/man/bitmask.1.rst +++ b/docs/man/bitmask.1.rst @@ -80,7 +80,6 @@ WARNING This software is still in its early phases of testing. So don't trust your life to it! -At the current time, Bitmask is not compatible with ``openresolv``, but it works with ``resolvconf``. FILES ===== -- cgit v1.2.3 From d550c15da5eed6c51735fcc0ef50bf004dd9e0e6 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Thu, 5 Jun 2014 11:00:22 -0500 Subject: add bitmask-root notes to checklist --- docs/release_checklist.wiki | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release_checklist.wiki b/docs/release_checklist.wiki index fc99fdf0..075591a7 100644 --- a/docs/release_checklist.wiki +++ b/docs/release_checklist.wiki @@ -1,5 +1,6 @@ = Bitmask Release Checklist (*) = * [ ] Check that all tests are passing! + * [ ] Check that the version in bitmask_client/pkg/linux/bitmask-root is bumped if needed. * [ ] Tag everything * Should be done for the following packages, in order: * [ ] 1. leap.common -- cgit v1.2.3 From 556c589dd470ed2b48b5421c38156333da78c369 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Thu, 5 Jun 2014 11:18:43 -0500 Subject: update manpages --- docs/man/bitmask-root.1.rst | 17 ++++++++++++----- docs/man/bitmask.1.rst | 4 ++-- 2 files changed, 14 insertions(+), 7 deletions(-) (limited to 'docs') diff --git a/docs/man/bitmask-root.1.rst b/docs/man/bitmask-root.1.rst index 7ed53aa9..c18cc4d6 100644 --- a/docs/man/bitmask-root.1.rst +++ b/docs/man/bitmask-root.1.rst @@ -7,23 +7,24 @@ privileged helper for bitmask, the encrypted internet access toolkit. ------------------------------------------------------------------------ :Author: LEAP Encryption Access Project https://leap.se -:Date: 2014-05-19 +:Date: 2014-06-05 :Copyright: GPLv3+ -:Version: 0.5.1 +:Version: 0.5.2 :Manual section: 1 :Manual group: General Commands Manual SYNOPSIS ======== -bitmask-root [openvpn | firewall | isup ] [start | stop] [ARGS] +bitmask-root [openvpn | firewall | version] [start | stop | isup] [ARGS] DESCRIPTION =========== *bitmask-root* is a privileged helper for bitmask. -It is used to start or stop openvpn and the bitmask firewall. +It is used to start or stop openvpn and the bitmask firewall. To operate, it +needs to be executed with root privileges. OPTIONS @@ -33,7 +34,9 @@ openvpn -------- **start** [ARGS] Starts openvpn. All args are passed to openvpn, and - filtered against a list of allowed args. + filtered against a list of allowed args. If the next + argument is `restart`, the firewall will not be teared + down in the case of errors lauching openvpn. **stop** Stops openvpn. @@ -46,6 +49,10 @@ firewall **stop** Stops the firewall. +version +-------- + +**version** Prints the `bitmask-root` version string. BUGS diff --git a/docs/man/bitmask.1.rst b/docs/man/bitmask.1.rst index 38da64af..6eae7ff5 100644 --- a/docs/man/bitmask.1.rst +++ b/docs/man/bitmask.1.rst @@ -7,9 +7,9 @@ graphical client to control LEAP, the encrypted internet access toolkit. ------------------------------------------------------------------------ :Author: LEAP Encryption Access Project https://leap.se -:Date: 2014-05-19 +:Date: 2014-06-05 :Copyright: GPLv3+ -:Version: 0.5.1 +:Version: 0.5.2 :Manual section: 1 :Manual group: General Commands Manual -- cgit v1.2.3