Content-type: text/html Manpage of MIXMINIONRC

MIXMINIONRC

Section: File Formats (5)
Updated: Anonymity
Index Return to Main Contents

BSD mandoc
GNU/Linux  

NAME

mixminionrc - Mixminion client configuration file  

SYNOPSIS

$HOME/.mixminionrc
$HOME/mixminionrc

 

DESCRIPTION

mixminion reads its configuration first from the command line, then from its configuration file, then from its built-in defaults. To find a configuration file, the software looks:

  1. In the configuration file specified with the command-line -f | --config flag, if any.
  2. $HOME/.mixminionrc
  3. $HOME/mixminionrc

If mixminion starts with no available configuration file, it creates one in the default location.

The file itself is line-based, with lines grouped into sections. Blank line and lines beginning with '#' are treated as comments. All section headings and entries must appear in the first column.

Each non-comment line is either a section header, of the format "[SectionName]", or an entry of the format "Key: Value". All names are case-sensitive. Unless otherwise noted, sections and entries may appear in any order, but no section or entry may appear more than once.

We describe the recognized entry keys below, grouped by section.  

The [Host] Section

ShredCommand
A program (such as 'shred -u') used to securely delete files. Bq Default: use internal overwrite-and-delete functionality.
EntropySource
A character device to provide secure random data for generating keys and seeding the internal pseudorandom number generator. Not used on Windows. Bo Default: try /dev/random /dev/srandom and /dev/random in an appropriate order. Bc
TrustedUser
The username of a user who should not trigger "file paranoia". For example, if /home/ is owned by the user "system", setting "TrustedUser: system" would prevent warnings on startup. This option may appear more than once. Bq Default: none.
FileParanoia
Boolean: If true, check file permissions on private files and directories and their parents. Bq Default: yes

 

The [User] Section

UserDir
Location to store a user's queued packets, cached directories, and so on. Bo Default: $HOME/.mixminion/ Bc

 

The [Security] Section

SURBAddress
Default address to use when generating SURBs without the -t option. Bq Default: none
SURBLifetime
Default lifetime for generated SURBs. Bq Default: 7 days
ForwardPath
Default path to use when generating forward (non-reply, non-SURB) packets. Bq Default: ~5
ReplyPath
Default path to use when generating reply packets. Bq Default: ~5
SURBPath
Default path to use when generating SURBs. Bq Default: ~5
BlockServers
A list of servers that should not be used when choosing random servers in path generation. This option may appear more than once. This servers will still be used if specifically requested. Bq Default: none
BlockEntries
A list of servers that should not be used when choosing a random first server in path generation. This option may appear more than once. This servers will still be used if specifically requested. Bq Default: none
BlockExits
A list of servers that should not be used when choosing a random last server in path generation. This option may appear more than once. This servers will still be used if specifically requested. Bq Default: none

 

The [DirectoryServers] Section

DirectoryTimeout
Maximum interval to wait for an answer when downloading a directory. Bq Default: 1 minute.

 

The [Network] Section

ConnectionTimeout
Maximum length of time to wait for an answer when opening a connection to a remote server. Bq Default: 2 minutes

 

Argument Formats

Boolean values
Boolean values are case-insensitive. "Yes", "y", "1", "true", and "on" are considered true; "No", "n", "0", "false" and "off" are considered false.
Intervals of time
Time intervals are given as a floating-point value, and a unit. The units may be single or plural. Recognized units are "second", "sec", "minute", "min", "hour", "day", "week", "month" (30 days), "mon", and "year" (365 days). "1.5 hour", "90 min", "90 minutes", and "5400 sec" are all the same value.
Lists
Lists of servers are separated by commas. Space is permitted, but not required.
Paths
The ForwardPath , ReplyPath and SURBPath entries expect path specifiers. See mixminion(1) for information on the proper format.

 

EXAMPLE

[Host]
# Don't try to overwrite files before removing them.
ShredCommand: rm -f
# Read entropy from /dev/urandom
EntopySource: /dev/urandom

[DirectoryServers]
DirectoryTimeout: 1 minute

[User]
# Store data in ~/share/mixminion/, instead of ~/.mixminion/
UserDir: ~/share/mixminion/

[Security]
SURBAddress: my-address@example.com
ForwardPath: ~5,FavoriteExit
ReplyPath: ~3,FavoriteExit
SURBPath: *3,FavoriteExit
BlockServers: insecure, malicious, nasty

[Network]
ConnectionTimeout: 180 seconds
 

AUTHORS

See the AUTHORS section in mixminion(1)  

SEE ALSO

mixminion(1) mixminiond(8)


 

Index

NAME
SYNOPSIS
DESCRIPTION
The [Host] Section
The [User] Section
The [Security] Section
The [DirectoryServers] Section
The [Network] Section
Argument Formats
EXAMPLE
AUTHORS
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 16:43:51 GMT, April 01, 2004