added manpages for CryptoBoxRootActions and CryptoBoxWebserver
improved packaging (setup.py) changelog updatedmaster
parent
34c2f26b52
commit
4bb5c9513b
@ -0,0 +1,2 @@
|
||||
# DO NOT REMOVE OR EDIT THIS FILE
|
||||
# the file was automatically generated by the cryptobox package
|
||||
@ -0,0 +1,84 @@
|
||||
.TH CryptoBoxRootActions 1 "November 02006" "cryptobox" "suid script"
|
||||
.SH NAME
|
||||
CryptoBoxRootActions \- The CryptoBoxWebserver calls this script in order to execute various programs which require root privileges.
|
||||
.SH SYNOPSIS
|
||||
.B CryptoBoxRootActions
|
||||
check
|
||||
.br
|
||||
.B CryptoBoxRootActions
|
||||
plugin \fIFEATURE_SCRIPT\fR [\fIARGS\fR]
|
||||
.br
|
||||
.B CryptoBoxRootActions
|
||||
hook \fIEVENT_SCRIPT\fR [\fIARGS\fR]
|
||||
.br
|
||||
.B CryptoBoxRootActions
|
||||
hook \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.
|
||||
.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:
|
||||
.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.
|
||||
.SH CONFIGURATION CHECK
|
||||
Call the CryptoBoxRootActions script with the argument \fIcheck\fR to test if
|
||||
\fBsuper\fR is configured properly. Just type the following:
|
||||
.RS
|
||||
.PP
|
||||
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.
|
||||
.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:
|
||||
.TP
|
||||
writable only for 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
|
||||
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.
|
||||
.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.
|
||||
.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.
|
||||
.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.
|
||||
.SH AUTHOR
|
||||
Written by Lars Kruse
|
||||
.SH "REPORTING BUGS"
|
||||
Report bugs to <devel@sumpfralle.de>
|
||||
.SH COPYRIGHT
|
||||
Copyright \(co 02006 Lars Kruse
|
||||
|
||||
@ -0,0 +1,55 @@
|
||||
.TH CryptoBoxWebserver 1 "November 02006" "cryptobox" "daemon"
|
||||
.SH NAME
|
||||
CryptoBoxWebserver \- start the webserver of the \fBCryptoBox\fR package.
|
||||
.SH SYNOPSIS
|
||||
.B CryptoBoxWebserver
|
||||
[\fIOPTIONS\fR]
|
||||
.SH DESCRIPTION
|
||||
.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
|
||||
simple access to your data.
|
||||
.SH OPTIONS
|
||||
The following options control the behaviour of the CryptoBoxWebserver:
|
||||
.TP
|
||||
\fB\-c\fR, \fB\-\-config\fR=\fBFILE\fR
|
||||
Uses the named configuration file.
|
||||
.TP
|
||||
\fB\-p\fR, \fB\-\-port\fR=\fBPORT\fR
|
||||
Specifiy a port to listen to.
|
||||
.TP
|
||||
\fB\-\-host\fR=\fBHOST\fR
|
||||
Specifiy the interface to listen to by providing a resolvable name or an ip. The server
|
||||
listens to all interfaces by default.
|
||||
.TP
|
||||
\fB\-B\fR
|
||||
Run the webserver in the background. Otherwise the terminal will stay attached to the
|
||||
process.
|
||||
.TP
|
||||
\fB\-q\fR
|
||||
Quiet output - only errors will get reported.
|
||||
.TP
|
||||
\fB\-\-pidfile\fR=\fFILE\fR
|
||||
Specify a pid file for the webserver.
|
||||
.TP
|
||||
\fB\-\-datadir\fR=\fDIRECTORY\fR
|
||||
Specify the location of the data directory of the webserver. The default location is
|
||||
\fI/usr/share/cryptobox/www-data\fR.
|
||||
.TP
|
||||
\fB\-\-version\fR
|
||||
Show the version of the \fBCryptoBox\fR 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.
|
||||
.SH AUTHOR
|
||||
Written by Lars Kruse
|
||||
.SH "REPORTING BUGS"
|
||||
Report bugs to <devel@sumpfralle.de>
|
||||
.SH COPYRIGHT
|
||||
Copyright \(co 02006 Lars Kruse
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
debian
|
||||
design
|
||||
stuff
|
||||
bin-perl-old
|
||||
package.exclude
|
||||
|
||||
Loading…
Reference in New Issue