Edgewall Software

Changes between Version 88 and Version 89 of TracStandalone


Ignore:
Timestamp:
Jan 13, 2011, 9:08:40 PM (13 years ago)
Author:
mikec@…
Comment:

#Using_Authentication: Improved description of Basic and Digest forms, provided link to online Basic p/w generator

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v88 v89  
    8787== Using Authentication ==
    8888
    89 Tracd provides support for both Basic and Digest authentication. The default is to use Digest; to use Basic authentication, replace `--auth` with `--basic-auth` in the examples below. (You must still specify a dialogic "realm", which can be an empty string by trailing the BASICAUTH with a comma.)
    90 
     89Tracd provides support for both Basic and Digest authentication. Digest is considered more secure. The examples below use Digest; to use Basic authentication, replace `--auth` with `--basic-auth` in the command line.
    9190
    9291The general format for using authentication is:
     
    9493 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
    9594}}}
    96 
    9795where:
    98 
    9996 * '''base_project_dir''': the base directory of the project specified as follows:
    10097   * when serving multiple projects: ''relative'' to the `project_path`
     
    104101 * '''realm''': the realm name (can be anything)
    105102 * '''project_path''': path of the project
    106  * **`--auth`** in the above means use Digest authentication, replace `--auth` with `--basic-auth` if you want to use Basic auth
     103
     104 * **`--auth`** in the above means use Digest authentication, replace `--auth` with `--basic-auth` if you want to use Basic auth.  Although Basic authentication does not require a "realm", the command parser does, so the second comma is required, followed directly by the closing quote for an empty realm name.
    107105
    108106Examples:
     
    128126}}}
    129127
    130 === Using a htpasswd password file ===
     128=== Basic Authorization: Using a htpasswd password file ===
    131129This section describes how to use `tracd` with Apache .htpasswd files.
    132130
    133131To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
    134 
    135132{{{
    136133 $ sudo htpasswd -c /path/to/env/.htpasswd username
     
    142139
    143140Then to start `tracd` run something like this:
    144 
    145141{{{
    146142 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
     
    148144
    149145For example:
    150 
    151146{{{
    152147 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
    153148}}}
    154 
    155149''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
    156150
    157 === Using a htdigest password file ===
     151=== Digest authentication: Using a htdigest password file ===
    158152
    159153If you have Apache available, you can use the htdigest command to generate the password file. Type 'htdigest' to get some usage instructions, or read [http://httpd.apache.org/docs/2.0/programs/htdigest.html this page] from the Apache manual to get precise instructions.  You'll be prompted for a password to enter for each user that you create.  For the name of the password file, you can use whatever you like, but if you use something like `users.htdigest` it will remind you what the file contains. As a suggestion, put it in your <projectname>/conf folder along with the [TracIni trac.ini] file.
     
    163157=== Generating Passwords Without Apache ===
    164158
    165 If you don't have Apache available, you can use this simple Python script to generate your passwords:
     159Basic Authorization can be accomplished via this [http://www.4webhelp.net/us/password.php online HTTP Password generator].  Copy the generated password-hash line to the .htpasswd file on your system.
     160
     161You can use this simple Python script to generate a '''digest''' password file:
    166162
    167163{{{
     
    197193}}}
    198194
    199 Note: If you use the above script you must use the --auth option to tracd, not --basic-auth, and you must set the realm in the --auth value to 'trac' (without the quotes). Example usage (assuming you saved the script as trac-digest.py):
     195Note: If you use the above script you must set the realm in the `--auth` argument to '''`trac`'''. Example usage (assuming you saved the script as trac-digest.py):
    200196
    201197{{{
     
    204200}}}
    205201
    206 
    207 Note: If you would like to use --basic-auth you need to use htpasswd tool from apache server to generate .htpasswd file. The remaining part is similar but make sure to use empty realm (i.e. coma after path). Make sure to use -m option for it.  If you do not have Apache, [trac:source:/tags/trac-0.11/contrib/htpasswd.py htpasswd.py] may help.  (Note that it requires a `crypt` or `fcrypt` module; see the source comments for details.)
    208 
    209 It is possible to use md5sum utility to generate digest-password file using such method:
     202==== Using `md5sum`
     203It is possible to use `md5sum` utility to generate digest-password file:
    210204{{{
    211205 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest