.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "AKEYCONVERT 8"
.TH AKEYCONVERT 8 "2021-12-09" "OpenAFS" "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
akeyconvert \- Import keys from rxkad.keytab to an AFS KeyFileExt
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBakeyconvert\fR \fI\-all\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBakeyconvert\fR command is used when upgrading an \s-1AFS\s0 cell from
the 1.6.x release series to the 1.8.x release series.
When using the rxkad\-k5 security extension, the 1.6.x release series
stored the \s-1AFS\s0 long-term Kerberos keys in a krb5 keytab file named
\&\fIrxkad.keytab\fR.  The 1.8.x series releases avoid widespread linking
against libkrb5, and instead store the \s-1AFS\s0 long-term Kerberos keys
in an OpenAFS-specific file format, the \fIKeyFileExt\fR\|(5).
.PP
\&\fBakeyconvert\fR provides an easy way to convert the \s-1AFS\s0 long-term
Kerberos keys from the krb5 keytab format to the KeyFileExt format.
The same functionality is possible via repeated use of \fIasetkey\fR\|(8),
but \fBakeyconvert\fR is provided to simplify the process.
.PP
By default, \fBakeyconvert\fR will only migrate the newest key (highest kvno)
for each Kerberos principal with a key in the rxkad.keytab.  The ability
to convert all keys, regardless of kvno, is provided as \fBakeyconvert \-all\fR.
.SH "CAUTIONS"
.IX Header "CAUTIONS"
The \fIKeyFileExt\fR format is slightly less flexible than the krb5
keytab format \*(-- the \fIKeyFileExt\fR identifies keys only by the
type (rxkad\-k5), kvno, and enctype (\*(L"subtype\*(R"), whereas the krb5 keytab
also stores the principal name associated with each key.  This means
that a krb5 keytab which contained keys of identical kvno and enctype,
but for different principals, would not be representable as a
\&\fIKeyFileExt\fR.  \fBakeyconvert\fR detects such a situation and does
not perform any key conversions until the conflict is removed.
.PP
Many of the concerns given in \fIasetkey\fR\|(8) regarding extracting
new Kerberos keys with \f(CW\*(C`ktadd\*(C'\fR are also applicable to changes
involving the \fIrxkad.keytab\fR.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
In a cell which is using the rxkad\-k5 extension, the following command
will read the newest keys from the \fIrxkad.keytab\fR and write them to the
\&\fIKeyFileExt\fR in the appropriate format.
.PP
.Vb 1
\&    % akeyconvert
.Ve
.PP
In a cell which has a key of kvno 2 and enctype aes128\-cts\-hmac\-sha1\-96
for both afs/example.com@EXAMPLE.COM and a different key with
the same kvno and enctype but for the principal afs@EXAMPLE.COM,
\&\fBakeyconvert\fR will detect the kvno/enctype collision and refuse to
continue.  The appropriate Kerberos keytab-manipulation tools should
be used to generate a new key (of higher kvno) for one of the colliding
principals and remove the old (colliding) key for that principal before
\&\fBakeyconvert\fR is used.
.PP
.Vb 3
\&    % akeyconvert \-all
\&    Duplicate kvno/enctype 2/17
\&    FATAL: duplicate key identifiers found.
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
The issuer must be able to read the \fIrxkad.keytab\fR and write the
\&\fIKeyFile\fR and \fIKeyFileExt\fR, normally \fI/usr/afs/etc/KeyFile\fR and
\&\fI/usr/afs/etc/KeyFileExt\fR.  In practice, this means that the issuer must be
the local superuser \f(CW\*(C`root\*(C'\fR on the \s-1AFS\s0 file server or database server.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIKeyFile\fR\|(5),
\&\fIKeyFileExt\fR\|(5),
\&\fIasetkey\fR\|(8),
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2015 Massachusetts Institute of Technology.
.PP
This documentation is covered by the \s-1IBM\s0 Public License Version 1.0.  This
man page was written by Benjamin Kaduk for OpenAFS.