1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/openpkg/uuid.8 Tue Jan 06 23:40:39 2009 +0100
1.3 @@ -0,0 +1,252 @@
1.4 +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
1.5 +.\"
1.6 +.\" Standard preamble:
1.7 +.\" ========================================================================
1.8 +.de Sh \" Subsection heading
1.9 +.br
1.10 +.if t .Sp
1.11 +.ne 5
1.12 +.PP
1.13 +\fB\\$1\fR
1.14 +.PP
1.15 +..
1.16 +.de Sp \" Vertical space (when we can't use .PP)
1.17 +.if t .sp .5v
1.18 +.if n .sp
1.19 +..
1.20 +.de Vb \" Begin verbatim text
1.21 +.ft CW
1.22 +.nf
1.23 +.ne \\$1
1.24 +..
1.25 +.de Ve \" End verbatim text
1.26 +.ft R
1.27 +.fi
1.28 +..
1.29 +.\" Set up some character translations and predefined strings. \*(-- will
1.30 +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
1.31 +.\" double quote, and \*(R" will give a right double quote. | will give a
1.32 +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
1.33 +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
1.34 +.\" expand to `' in nroff, nothing in troff, for use with C<>.
1.35 +.tr \(*W-|\(bv\*(Tr
1.36 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
1.37 +.ie n \{\
1.38 +. ds -- \(*W-
1.39 +. ds PI pi
1.40 +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
1.41 +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
1.42 +. ds L" ""
1.43 +. ds R" ""
1.44 +. ds C`
1.45 +. ds C'
1.46 +'br\}
1.47 +.el\{\
1.48 +. ds -- \|\(em\|
1.49 +. ds PI \(*p
1.50 +. ds L" ``
1.51 +. ds R" ''
1.52 +'br\}
1.53 +.\"
1.54 +.\" If the F register is turned on, we'll generate index entries on stderr for
1.55 +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
1.56 +.\" entries marked with X<> in POD. Of course, you'll have to process the
1.57 +.\" output yourself in some meaningful fashion.
1.58 +.if \nF \{\
1.59 +. de IX
1.60 +. tm Index:\\$1\t\\n%\t"\\$2"
1.61 +..
1.62 +. nr % 0
1.63 +. rr F
1.64 +.\}
1.65 +.\"
1.66 +.\" For nroff, turn off justification. Always turn off hyphenation; it makes
1.67 +.\" way too many mistakes in technical documents.
1.68 +.hy 0
1.69 +.if n .na
1.70 +.\"
1.71 +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
1.72 +.\" Fear. Run. Save yourself. No user-serviceable parts.
1.73 +. \" fudge factors for nroff and troff
1.74 +.if n \{\
1.75 +. ds #H 0
1.76 +. ds #V .8m
1.77 +. ds #F .3m
1.78 +. ds #[ \f1
1.79 +. ds #] \fP
1.80 +.\}
1.81 +.if t \{\
1.82 +. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
1.83 +. ds #V .6m
1.84 +. ds #F 0
1.85 +. ds #[ \&
1.86 +. ds #] \&
1.87 +.\}
1.88 +. \" simple accents for nroff and troff
1.89 +.if n \{\
1.90 +. ds ' \&
1.91 +. ds ` \&
1.92 +. ds ^ \&
1.93 +. ds , \&
1.94 +. ds ~ ~
1.95 +. ds /
1.96 +.\}
1.97 +.if t \{\
1.98 +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
1.99 +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
1.100 +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
1.101 +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
1.102 +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
1.103 +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
1.104 +.\}
1.105 +. \" troff and (daisy-wheel) nroff accents
1.106 +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
1.107 +.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
1.108 +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
1.109 +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
1.110 +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
1.111 +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
1.112 +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
1.113 +.ds ae a\h'-(\w'a'u*4/10)'e
1.114 +.ds Ae A\h'-(\w'A'u*4/10)'E
1.115 +. \" corrections for vroff
1.116 +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
1.117 +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
1.118 +. \" for low resolution devices (crt and lpr)
1.119 +.if \n(.H>23 .if \n(.V>19 \
1.120 +\{\
1.121 +. ds : e
1.122 +. ds 8 ss
1.123 +. ds o a
1.124 +. ds d- d\h'-1'\(ga
1.125 +. ds D- D\h'-1'\(hy
1.126 +. ds th \o'bp'
1.127 +. ds Th \o'LP'
1.128 +. ds ae ae
1.129 +. ds Ae AE
1.130 +.\}
1.131 +.rm #[ #] #H #V #F C
1.132 +.\" ========================================================================
1.133 +.\"
1.134 +.IX Title "UUID 8"
1.135 +.TH UUID 8 "OpenPKG" "UUID(8)" "OpenPKG"
1.136 +.SH "NAME"
1.137 +\&\fBopenpkg uuid\fR \- OpenPKG UUID Update Utility
1.138 +.SH "SYNOPSIS"
1.139 +.IX Header "SYNOPSIS"
1.140 +\&\fBopenpkg uuid\fR [\fB\-\-verbose\fR] [\fB\-\-multicast\fR] \fBreset\fR|\fBupdate\fR|\fBinfo\fR
1.141 +.SH "DESCRIPTION"
1.142 +.IX Header "DESCRIPTION"
1.143 +The \fBopenpkg uuid\fR command is the maintenance utility for the \s-1DCE\s0 1.1
1.144 +and \s-1ISO/IEC\s0 11578:1996 compliant \fIUniversally Unique Identifiers\fR
1.145 +(\s-1UUID\s0) of an \fBOpenPKG\fR instance. It is internally based on \fB\s-1OSSP\s0
1.146 +uuid\fR.
1.147 +.PP
1.148 +UUIDs are 128 bit numbers which are intended to have a high likelihood
1.149 +of uniqueness over space and time and are computationally difficult
1.150 +to guess. They are globally unique identifiers which can be locally
1.151 +generated without contacting a global registration authority. UUIDs are
1.152 +intended as unique identifiers for both mass tagging objects with an
1.153 +extremely short lifetime and to reliably identifying very persistent
1.154 +objects across a network. The three classical \s-1UUID\s0 variants are \s-1DCE\s0 1.1
1.155 +UUIDs of version 1 (time and node based), version 3 (name based) and
1.156 +version 4 (random number based).
1.157 +.PP
1.158 +For an \fBOpenPKG\fR instance, three different UUIDs are used:
1.159 +.ie n .IP "1. \fBOpenPKG Registry\fR (\*(C`UUID_REGISTRY\*(C')" 3
1.160 +.el .IP "1. \fBOpenPKG Registry\fR (\f(CW\*(C`UUID_REGISTRY\*(C'\fR)" 3
1.161 +.IX Item "1. OpenPKG Registry (UUID_REGISTRY)"
1.162 +This is a version 1 \s-1UUID\s0 which uniquely identifiers the \fBOpenPKG\fR
1.163 +instance for global registration purposes. It is generated just once in
1.164 +the lifetime of the \fBOpenPKG\fR instance. The value of this \s-1UUID\s0 cannot
1.165 +be recalculated deterministically.
1.166 +.ie n .IP "2. \fBOpenPKG Instance\fR (\*(C`UUID_INSTANCE\*(C')" 3
1.167 +.el .IP "2. \fBOpenPKG Instance\fR (\f(CW\*(C`UUID_INSTANCE\*(C'\fR)" 3
1.168 +.IX Item "2. OpenPKG Instance (UUID_INSTANCE)"
1.169 +This is a version 3 \s-1UUID\s0 which summarizes the \fBOpenPKG\fR
1.170 +instance parameters. Currently the values of the following
1.171 +particular OpenPKG \s-1RPM\s0 macros are uses as input:
1.172 +.Sp
1.173 +.Vb 5
1.174 +\& %{l_openpkg_release} %{l_prefix}
1.175 +\& %{l_susr} %{l_suid} %{l_sgrp} %{l_sgid}
1.176 +\& %{l_musr} %{l_muid} %{l_mgrp} %{l_mgid}
1.177 +\& %{l_rusr} %{l_ruid} %{l_rgrp} %{l_rgid}
1.178 +\& %{l_nusr} %{l_nuid} %{l_ngrp} %{l_ngid}
1.179 +.Ve
1.180 +.Sp
1.181 +The value of this \s-1UUID\s0 can be recalculated deterministically and will
1.182 +not chance as long as none of the values of the above macro do not
1.183 +change. This \s-1UUID\s0 can be used for detecting OpenPKG release upgrades,
1.184 +accidentally changed UIDs or GIDs, etc. Notice that version 3 UUIDs are
1.185 +message digests (actually \s-1MD5\s0 based) and so are one-way functions which do
1.186 +not allow one to recalculate the input values from the \s-1UUID\s0.
1.187 +.ie n .IP "3. \fBOpenPKG Platform\fR (\*(C`UUID_PLATFORM\*(C')" 3
1.188 +.el .IP "3. \fBOpenPKG Platform\fR (\f(CW\*(C`UUID_PLATFORM\*(C'\fR)" 3
1.189 +.IX Item "3. OpenPKG Platform (UUID_PLATFORM)"
1.190 +This is a version 3 \s-1UUID\s0 which summarizes the \fBOpenPKG\fR platform
1.191 +parameters. Currently the OpenPKG \s-1RPM\s0 platform id plus the \s-1FQDN\s0 and \s-1IP\s0
1.192 +address of the underlying host are used as input. This \s-1UUID\s0 can be used
1.193 +for detecting operating system and host changes. Notice that version
1.194 +3 UUIDs are message digests (actually \s-1MD5\s0 based) and so are one-way
1.195 +functions which do not allow one to recalculate the input values from
1.196 +the \s-1UUID\s0.
1.197 +.SH "OPTIONS"
1.198 +.IX Header "OPTIONS"
1.199 +.IP "\fB\-\-verbose\fR" 4
1.200 +.IX Item "--verbose"
1.201 +Print verbose messages during operation.
1.202 +.IP "\fB\-\-multicast\fR" 4
1.203 +.IX Item "--multicast"
1.204 +Generate a random multicast \s-1MAC\s0 address instead of using the real \s-1IEEE\s0
1.205 +802 \s-1MAC\s0 address of the underlying host when generating the version 1
1.206 +\&\s-1UUID\s0 \f(CW\*(C`UUID_REGISTRY\*(C'\fR.
1.207 +.SH "COMMANDS"
1.208 +.IX Header "COMMANDS"
1.209 +.IP "\fBreset\fR" 4
1.210 +.IX Item "reset"
1.211 +This resets the three UUIDs \f(CW\*(C`UUID_REGISTRY\*(C'\fR, \f(CW\*(C`UUID_INSTANCE\*(C'\fR and
1.212 +\&\f(CW\*(C`UUID_PLATFORM\*(C'\fR to the \*(L"Nil \s-1UUID\s0\*(R". They are then automatically
1.213 +regenerated within one day if already done explicitly afterward with
1.214 +"\f(CW\*(C`openpkg uuid update\*(C'\fR".
1.215 +.IP "\fBupdate\fR" 4
1.216 +.IX Item "update"
1.217 +This updates the three UUIDs \f(CW\*(C`UUID_REGISTRY\*(C'\fR, \f(CW\*(C`UUID_INSTANCE\*(C'\fR and
1.218 +\&\f(CW\*(C`UUID_PLATFORM\*(C'\fR to the \*(L"Nil \s-1UUID\s0\*(R". \f(CW\*(C`UUID_REGISTRY\*(C'\fR is kept unless it
1.219 +is the \*(L"Nil \s-1UUID\s0\*(R" (see "\f(CW\*(C`openpkg uuid reset\*(C'\fR" command above). The UUIDs
1.220 +\&\f(CW\*(C`UUID_INSTANCE\*(C'\fR and \f(CW\*(C`UUID_PLATFORM\*(C'\fR are updated only if their input
1.221 +values (and this way the resulting UUIDs) have changed. This operation
1.222 +is performed daily automatically.
1.223 +.IP "\fBinfo\fR" 4
1.224 +.IX Item "info"
1.225 +This print summary page of identification information, including all
1.226 +UUIDs and all of their calculation inputs.
1.227 +.SH "FILES"
1.228 +.IX Header "FILES"
1.229 +The three UUIDs of the \fBOpenPKG\fR instance are stored in the file
1.230 +\&\f(CW\*(C`@l_prefix@/etc/openpkg/uuid\*(C'\fR in Bourne-Shell syntax. An example
1.231 +content is:
1.232 +.PP
1.233 +.Vb 3
1.234 +\& UUID_REGISTRY="81eca44e-4d18-11d8-a837-0090272ff725"
1.235 +\& UUID_INSTANCE="c55a8d2d-31bb-3ae0-9edb-68337af61acc"
1.236 +\& UUID_PLATFORM="05ec2532-9e3f-37dc-a7ed-b291c2c463ed"
1.237 +.Ve
1.238 +.SH "CAVEATS"
1.239 +.IX Header "CAVEATS"
1.240 +By default and in full compliance with \s-1DCE\s0 1.1 and \s-1ISO/IEC\s0 11578:1996,
1.241 +the OpenPKG Registry \s-1UUID\s0 (\f(CW\*(C`UUID_REGISTRY\*(C'\fR) contains the \s-1IEEE\s0 802 \s-1MAC\s0
1.242 +address of the underlying host. If this is not acceptable by local
1.243 +security policies you can easily at any time generate a new OpenPKG
1.244 +Registry \s-1UUID\s0 with a random multicast \s-1MAC\s0 address instead by running:
1.245 +.PP
1.246 +.Vb 2
1.247 +\& $ openpkg uuid reset
1.248 +\& $ openpkg uuid --multicast update
1.249 +.Ve
1.250 +.SH "SEE ALSO"
1.251 +.IX Header "SEE ALSO"
1.252 +\&\fB\s-1OSSP\s0 uuid\fR <http://www.ossp.org/pkg/lib/uuid/>.
1.253 +.SH "HISTORY"
1.254 +.IX Header "HISTORY"
1.255 +The \fBopenpkg uuid\fR command first appeared in \fBOpenPKG 2.0\fR.
