freebsd-dev/crypto/heimdal/kdc/string2key.8
2008-05-07 13:39:42 +00:00

111 lines
2.9 KiB
Groff

.\" Copyright (c) 2000 - 2002 Kungliga Tekniska Högskolan
.\" (Royal Institute of Technology, Stockholm, Sweden).
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\"
.\" 2. 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.
.\"
.\" 3. Neither the name of the Institute nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE 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 INSTITUTE 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.
.\"
.\" $Id: string2key.8 11648 2003-02-16 21:10:32Z lha $
.\"
.Dd March 4, 2000
.Dt STRING2KEY 8
.Os HEIMDAL
.Sh NAME
.Nm string2key
.Nd map a password into a key
.Sh SYNOPSIS
.Nm
.Op Fl 5 | Fl -version5
.Op Fl 4 | Fl -version4
.Op Fl a | Fl -afs
.Oo Fl c Ar cell \*(Ba Xo
.Fl -cell= Ns Ar cell
.Xc
.Oc
.Oo Fl w Ar password \*(Ba Xo
.Fl -password= Ns Ar password
.Xc
.Oc
.Oo Fl p Ar principal \*(Ba Xo
.Fl -principal= Ns Ar principal
.Xc
.Oc
.Oo Fl k Ar string \*(Ba Xo
.Fl -keytype= Ns Ar string
.Xc
.Oc
.Ar password
.Sh DESCRIPTION
.Nm
performs the string-to-key function.
This is useful when you want to handle the raw key instead of the password.
Supported options:
.Bl -tag -width Ds
.It Xo
.Fl 5 ,
.Fl -version5
.Xc
Output Kerberos v5 string-to-key
.It Xo
.Fl 4 ,
.Fl -version4
.Xc
Output Kerberos v4 string-to-key
.It Xo
.Fl a ,
.Fl -afs
.Xc
Output AFS string-to-key
.It Xo
.Fl c Ar cell ,
.Fl -cell= Ns Ar cell
.Xc
AFS cell to use
.It Xo
.Fl w Ar password ,
.Fl -password= Ns Ar password
.Xc
Password to use
.It Xo
.Fl p Ar principal ,
.Fl -principal= Ns Ar principal
.Xc
Kerberos v5 principal to use
.It Xo
.Fl k Ar string ,
.Fl -keytype= Ns Ar string
.Xc
Keytype
.It Xo
.Fl -version
.Xc
print version
.It Xo
.Fl -help
.Xc
.El