- Documentation for mkha1

1 files changed, 97 insertions, 0 deletions

diff --git a/doc/mkha1.8 b/doc/mkha1.8
new file mode 100644
index 0000000..eb48ccd
--- /dev/null
+++ b/doc/mkha1.8
@@ -0,0 +1,97 @@
+.\" 
+.\" Copyright (c) 2004, Nate Nielsen
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without 
+.\" modification, are permitted provided that the following conditions 
+.\" are met:
+.\" 
+.\"     * Redistributions of source code must retain the above 
+.\"       copyright notice, this list of conditions and the 
+.\"       following disclaimer.
+.\"     * Redistributions in binary form must reproduce the 
+.\"       above copyright notice, this list of conditions and 
+.\"       the following disclaimer in the documentation and/or 
+.\"       other materials provided with the distribution.
+.\"     * The names of contributors to this software may not be 
+.\"       used to endorse or promote products derived from this 
+.\"       software without specific prior written permission.
+.\" 
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
+.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
+.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
+.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
+.\" COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
+.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
+.\" OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
+.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
+.\" THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
+.\" DAMAGE.
+.\" 
+.\"
+.\" CONTRIBUTORS
+.\"  Nate Nielsen <nielsen@memberwebs.com>
+.\"
+.Dd August, 2004
+.Dt mkha1 8
+.Os httpauth 
+.Sh NAME
+.Nm mkha1
+.Nd a tool for creating Digest-MD5 HA1 hashes
+.Sh SYNOPSIS
+.Nm
+.Op Fl u Ar username
+.Op Fl r Ar realm
+.Op Fl p Ar password
+.Nm
+.Fl b
+.Op Fl s
+.Sh DESCRIPTION
+.Nm
+is a tool that creates Digest-MD5 hashes. These are used to perform HTTP Digest 
+authentication. Storing these hashes is more secure than storing plain text 
+passwords. An HA1 is an MD5 hash of the username, realm and password for the 
+given user. 
+.Pp
+.Nm 
+will prompt you for the information it needs to create an HA1 hash and then
+output that hash on the console. You can use this tool in scripts to put hashes 
+in your database. 
+.Pp
+When used in batch mode (by specifying the 
+.Fl b
+option) 
+.Nm 
+reads user information from it's input and outputs hashes for each user. Each input 
+line should be in the following format:
+.Pp
+.Dl user:realm:password
+.Pp
+.Sh OPTIONS
+The options are as follows:
+.Bl -tag -width Fl
+.It Fl b
+Batch mode (described above).
+.It Fl p
+The 
+.Ar password 
+to hash. When not specified on the command line 
+.Nm 
+will prompt you for it.
+.It Fl r
+The 
+.Ar realm 
+for the HA1 hash. When not specified you'll be prompted.
+.It Fl s
+When in batch mode output only the plain hashes. 
+.It Fl u
+The 
+.Ar username
+for the HA1 hash. When not specified you'll be prompted for it.
+.El
+.Sh SEE ALSO
+.Xr httpauthd 8
+.Sh AUTHOR
+.An Nate Nielsen Aq nielsen@memberwebs.com