Browse Source

fixed some minor spelling

master
lars 15 years ago
parent
commit
518e347a40
  1. 66
      man/CryptoBoxRootActions.8
  2. 22
      man/CryptoBoxWebserver.8

66
man/CryptoBoxRootActions.8

@ -1,6 +1,7 @@
.TH CryptoBoxRootActions 1 "November 02006" "cryptobox" "suid script"
.TH CryptoBoxRootActions 8 "March 02007" "CryptoBox" "CryptoBox-Server manual"
.SH NAME
CryptoBoxRootActions \- The CryptoBoxWebserver calls this script in order to execute various programs which require root privileges.
CryptoBoxRootActions \- The CryptoBoxWebserver calls this script in order to
execute various programs which require root privileges.
.SH SYNOPSIS
.B CryptoBoxRootActions
check
@ -12,22 +13,24 @@ plugin \fIFEATURE_SCRIPT\fR [\fIARGS\fR]
hook \fIEVENT_SCRIPT\fR [\fIARGS\fR]
.br
.B CryptoBoxRootActions
hook \fIPROG\fR [\fIARGS\fR]
\fIPROG\fR [\fIARGS\fR]
.SH DESCRIPTION
CryptoBoxRootActions is a script that is called by the \fBCryptoBox\fR to execute
programs which require root privileges. You will never call this program directly. This
manpage should only be useful as a reference for developers of the CryptoBox.
CryptoBoxRootActions is a script that is called by the
\fBCryptoBox\fR-Server to execute programs which require root privileges. You
will never call this program directly. This manpage should only be useful as a
reference for developers of the CryptoBox.
.PP
To let the CryptoBox gain root permissions you need the program \fBsuper\fR.
It is configured properly if it \fI/etc/super.tab\fR contains the following line:
To let the CryptoBox-Server gain root permissions you need the program
\fBsuper\fR. It is configured properly if \fI/etc/super.tab\fR contains the
following line:
.RS
.PP
CryptoBoxRootActions /usr/sbin/CryptoBoxRootActions cryptobox
.RE
.PP
We assume that the CryptoBoxRootActions script is located at
\fI/usr/sbin/CryptoBoxRootActions\fR. Furthermore the user running the CryptoBox
server is assumed to be \fIcryptobox\fR.
\fI/usr/sbin/CryptoBoxRootActions\fR. Furthermore the user running the
CryptoBox-Server is assumed to be \fIcryptobox\fR.
.SH CONFIGURATION CHECK
Call the CryptoBoxRootActions script with the argument \fIcheck\fR to test if
\fBsuper\fR is configured properly. Just type the following:
@ -36,49 +39,56 @@ Call the CryptoBoxRootActions script with the argument \fIcheck\fR to test if
super CryptoBoxRootActions check; echo $?
.RE
.PP
This should output '0' for success. Any other value indicates a problem and should
be accompanied by a descriptive error message.
This should output '0' for success. Any other value indicates a problem and
should be accompanied by a descriptive error message.
.SH FEATURE SCRIPTS
The CryptoBox can be easily extended with new features. Refer to the developer
documentation of the CryptoBox for more details.
.PP
If a feature needs root privileges to accomplish its function, then you have to write
a separate python script for these actions. This script mus fulfill the following
conditions:
If a feature needs root privileges to accomplish its function, then you have to
write a separate python script for these actions. This script must fulfill the
following conditions:
.TP
writable only for root
The script and all its parent directories may not be writable for anyone except root.
The script and all its parent directories may not be writable for anyone except
root.
.TP
must be executable
The execution permission bit of the script must be set.
.TP
marking member
required member
The script must contain a member called \fBPLUGIN_TYPE\fR with the string value
\fIcryptobox\fR. This prevents the execution of arbitrary scripts.
.SH EVENT SCRIPTS
The CryptoBox calls all scripts within a given directory whenever specific events
occour. Possible events are mounting and unmounting of disks or the bootup or shutdown
of the CryptoBox. Refer to \fI/usr/share/doc/cryptobox/event-scripts/README\fR
for further details.
The CryptoBox-Server calls all scripts within a given directory whenever
specific events occour. Possible events are mounting and unmounting of disks or
the bootup or shutdown of the CryptoBox-Server. Refer to
\fI/usr/share/doc/cryptobox-server/event-scripts/README\fR for further details.
.PP
An event script must fulfill the following conditions:
.TP
writable only for root
The script and all its parent directories must not be writable for anyone except root.
The script and all its parent directories must not be writable for anyone
except root.
.TP
must be executable
The execution permission bit of the script must be set.
.TP
marked directory
The directory of the script must also contain a file called \fI_cryptobox_events_\fR to prevent the execution of arbitrary scripts.
directory must be marked
The directory of the script must also contain a file called
\fI_cryptobox_events_\fR to prevent the execution of arbitrary scripts.
.SH SELECTED PROGRAMS
Very few selected programs may be called via CryptoBoxRootActions. Examples
are \fBcryptsetup\fR and \fBmount\fR. Refer to the source of CryptoBoxRootActions
for details.
are \fBcryptsetup\fR and \fBmount\fR. Refer to the source of
CryptoBoxRootActions for details.
.SH AUTHOR
Written by Lars Kruse
.SH "REPORTING BUGS"
.SH REPORTING BUGS
Report bugs to <devel@sumpfralle.de>
.SH COPYRIGHT
Copyright \(co 02006 Lars Kruse
Copyright \(co 02006-02007 Lars Kruse
.br
This is free software. You may redistribute copies of it under the terms of the
GNU General Public License <http://www.gnu.org/licenses/gpl.html>. There is NO
WARRANTY, to the extent permitted by law.

22
man/CryptoBoxWebserver.8

@ -1,6 +1,6 @@
.TH CryptoBoxWebserver 1 "November 02006" "cryptobox" "daemon"
.TH CryptoBoxWebserver 8 "March 02007" "CryptoBox" "CryptoBox-Server manual"
.SH NAME
CryptoBoxWebserver \- start the webserver of the \fBCryptoBox\fR package.
CryptoBoxWebserver \- start the webserver of the \fBCryptoBox\fR-Server package.
.SH SYNOPSIS
.B CryptoBoxWebserver
[\fIOPTIONS\fR]
@ -8,7 +8,7 @@ CryptoBoxWebserver \- start the webserver of the \fBCryptoBox\fR package.
.PP
The CryptoBoxWebserver is a web interface that allows you to manage encrypted and
plaintext disks of your computer without using the commandline interface. It works
easily together with \fBsamba\fR, \fBapache2-dav\fI and \fBftp\fR servers to provide
easily together with \fBsamba\fR, \fBapache2-dav\fR and \fBftp\fR servers to provide
simple access to your data.
.SH OPTIONS
The following options control the behaviour of the CryptoBoxWebserver:
@ -39,21 +39,25 @@ Specify a pid file for the webserver.
.TP
\fB\-\-datadir\fR=\fBDIRECTORY\fR
Specify the location of the data directory of the webserver. The default location is
\fI/usr/share/cryptobox/www-data\fR.
\fI/usr/share/cryptobox-server/www-data\fR.
.TP
\fB\-\-version\fR
Show the version of the \fBCryptoBox\fR and exit immediately.
Show the version of the \fBCryptoBox\fR-Server and exit immediately.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show the help message and exit.
.SH ENVIRONMENT VARIABLES
.IP PYTHONPATH
You may want to define this variable in case that you installed the \fBCryptoBox\fR
python package in a non-default location.
You may want to define this variable in case that you installed the
\fBCryptoBox\fR-Server python package in a non-default location.
.SH AUTHOR
Written by Lars Kruse
.SH "REPORTING BUGS"
.SH REPORTING BUGS
Report bugs to <devel@sumpfralle.de>
.SH COPYRIGHT
Copyright \(co 02006 Lars Kruse
Copyright \(co 02006-02007 Lars Kruse
.br
This is free software. You may redistribute copies of it under the terms of the
GNU General Public License <http://www.gnu.org/licenses/gpl.html>. There is NO
WARRANTY, to the extent permitted by law.

Loading…
Cancel
Save