usr.bin/csup/cpasswd.1

   1 .\" Copyright 1999-2003 John D. Polstra.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgment:
  14 .\"      This product includes software developed by John D. Polstra.
  15 .\" 4. The name of the author may not be used to endorse or promote products
  16 .\"    derived from this software without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $Id: cvpasswd.1,v 1.4 2003/03/04 18:24:42 jdp Exp $
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd June 27, 2007
  33 .Dt CPASSWD 1
  34 .Os FreeBSD
  35 .Sh NAME
  36 .Nm cpasswd
  37 .Nd scramble passwords for csup authentication
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Ar clientName
  41 .Ar serverName
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 utility creates scrambled passwords for the
  46 .Nm CVSup
  47 server's authentication database.  It is invoked with a client name
  48 and a server name.
  49 .Ar ClientName
  50 is the name the client uses to gain access to the
  51 server.  By convention, e-mail addresses are used for all client
  52 names, e.g.,
  53 .Ql BillyJoe@FreeBSD.org .
  54 Client names are case-insensitive.
  55 .Pp
  56 .Ar ServerName
  57 is the name of the
  58 .Nm CVSup
  59 server which the client wishes to access.  By convention,
  60 it is the canonical fully-qualified domain name of the server, e.g.,
  61 .Ql CVSup.FreeBSD.ORG .
  62 This must agree with the server's own idea of its name.  The name is
  63 case-insensitive.
  64 .Pp
  65 To set up authentication for a given server, one must perform the
  66 following steps:
  67 .Bl -enum
  68 .It
  69 Obtain the official
  70 .Ar serverName
  71 from the administrator of the server or from some other source.
  72 .It
  73 Choose an appropriate
  74 .Ar clientName .
  75 It should be in the form of a valid e-mail address, to make it easy
  76 for the server administrator to contact the user if necessary.
  77 .It
  78 Choose an arbitrary secret
  79 .Ar password .
  80 .It
  81 Run
  82 .Nm cpasswd ,
  83 and type in the
  84 .Ar password
  85 when prompted for it.  The utility will print out a line to send
  86 to the server administrator, and instruct you how to modify your
  87 .Li $ Ns Ev HOME Ns Pa /.csup/auth
  88 file.  You should use a secure channel to send the line to the
  89 server administrator.
  90 .El
  91 .Pp
  92 Since
  93 .Li $ Ns Ev HOME Ns Pa /.csup/auth
  94 contains passwords, you should ensure that it is not readable by
  95 anyone except yourself.
  96 .Sh FILES
  97 .Bl -tag -width $HOME/.csup/authxx -compact
  98 .It Li $ Ns Ev HOME Ns Pa /.csup/auth
  99 Authentication password file.
 100 .El
 101 .Sh SEE ALSO
 102 .Xr csup 1 ,
 103 .Xr cvsup 1 ,
 104 .Xr cvsupd 8 .
 105 .Bd -literal
 106 http://www.cvsup.org/
 107 .Ed
 108 .Sh AUTHORS
 109 .An -nosplit
 110 .An Petar Zhivkov Petrov Aq pesho.petrov@gmail.com
 111 is the author of
 112 .Nm ,
 113 the rewrite of
 114 .Nm cvpasswd .
 115 .An John Polstra Aq jdp@polstra.com
 116 is the author of
 117 .Nm CVSup .
 118 .Sh LEGALITIES
 119 CVSup is a registered trademark of John D. Polstra.