rooty/yubikey-val
1
0
Fork 0
mirror of https://github.com/Yubico/yubikey-val.git synced 2025-03-05 06:29:36 +01:00
Code Issues Projects Releases Wiki Activity

Added man pages.

Browse Source
This commit is contained in:
Dain Nilsson 2013-01-30 10:54:44 +01:00
parent 5e9b63d102
commit 6cb16f2125
8 changed files with 393 additions and 1 deletions

13
Makefile

@ -7,6 +7,9 @@ CODE = COPYING Makefile NEWS ykval-checksum-clients \
ykval-sync.php ykval-verify.php ykval-export-clients \
ykval-import-clients ykval-db-oci.php ykval-db-pdo.php \
ykval-db.oracle.sql ykval-resync.php ykval-checksum-deactivated
MANS = ykval-queue.1 ykval-import.1 ykval-export.1 \
ykval-import-clients.1 ykval-export-clients.1 \
ykval-checksum-clients.1 ykval-checksum-deactivated.1
MUNIN = ykval-munin-ksmlatency.php ykval-munin-vallatency.php \
ykval-munin-queuelength.php ykval-munin-responses.pl \
ykval-munin-yubikeystats.php
@ -25,6 +28,7 @@ etcprefix = /etc/yubico/val
sbinprefix = /usr/sbin
phpprefix = /usr/share/yubikey-val
docprefix = /usr/share/doc/yubikey-val
manprefix = /usr/share/man/man1
muninprefix = /usr/share/munin/plugins
wwwgroup = www-data
@ -45,6 +49,13 @@ install:
install -D ykval-import-clients $(DESTDIR)$(sbinprefix)/ykval-import-clients
install -D ykval-checksum-clients $(DESTDIR)$(sbinprefix)/ykval-checksum-clients
install -D ykval-checksum-deactivated $(DESTDIR)$(sbinprefix)/ykval-checksum-deactivated
install -D ykval-queue.1 $(DESTDIR)$(manprefix)/ykval-queue.1
install -D ykval-import.1 $(DESTDIR)$(manprefix)/ykval-import.1
install -D ykval-export.1 $(DESTDIR)$(manprefix)/ykval-export.1
install -D ykval-import-clients.1 $(DESTDIR)$(manprefix)/ykval-import-clients.1
install -D ykval-export-clients.1 $(DESTDIR)$(manprefix)/ykval-export-clients.1
install -D ykval-checksum-clients.1 $(DESTDIR)$(manprefix)/ykval-checksum-clients.1
install -D ykval-checksum-deactivated.1 $(DESTDIR)$(manprefix)/ykval-checksum-deactivated.1
install -D ykval-munin-ksmlatency.php $(DESTDIR)$(muninprefix)/ykval_ksmlatency
install -D ykval-munin-vallatency.php $(DESTDIR)$(muninprefix)/ykval_vallatency
install -D ykval-munin-queuelength.php $(DESTDIR)$(muninprefix)/ykval_queuelength
@ -76,7 +87,7 @@ $(PACKAGE)-$(VERSION).tgz: $(FILES)
git submodule init
git submodule update
mkdir $(PACKAGE)-$(VERSION) $(PACKAGE)-$(VERSION)/doc
cp $(CODE) $(MUNIN) $(PACKAGE)-$(VERSION)/
cp $(CODE) $(MANS) $(MUNIN) $(PACKAGE)-$(VERSION)/
cp $(DOCS) $(PACKAGE)-$(VERSION)/doc/
git2cl > $(PACKAGE)-$(VERSION)/ChangeLog
tar cfz $(PACKAGE)-$(VERSION).tgz $(PACKAGE)-$(VERSION)

56
ykval-checksum-clients.1 Normal file

@ -0,0 +1,56 @@
.\" Copyright (c) 2011-2013 Yubico AB
.\" 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.
.\"
.\" 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.
.\"
.\" The following commands are required for all man pages.
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.TH ykval-checksum-clients "1" "January 2013" "yubico-val"
.SH NAME
ykval-checksum-clients - Calculate a checksum of all Client Info data.
.SH SYNOPSIS
.B ykval-checksum-clients
.SH DESCRIPTION
Calculates a checksum using the id, active, and secret fields of all Client
Info data in the yubikey-val server database. This checksum can be used to
easily compare the state of clients in two yubikey-val servers in the same
sync pool.
Database configuration is read from /etc/yubico/val/ykval-config.php
.SH BUGS
Report ykval-checksum-clients bugs in
.URL "https://github.com/Yubico/yubikey-val/issues" "the issue tracker"
.SH "SEE ALSO"
.BR ykval-checksum-deactivated (1)
The
.URL "https://github.com/Yubico/yubikey-val" "yubikey-val home page"
.PP
YubiKeys can be obtained from
.URL "http://www.yubico.com/" "Yubico" "."

53
ykval-checksum-deactivated.1 Normal file

@ -0,0 +1,53 @@
.\" Copyright (c) 2011-2013 Yubico AB
.\" 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.
.\"
.\" 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.
.\"
.\" The following commands are required for all man pages.
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.TH ykval-checksum-deactivated "1" "January 2013" "yubico-val"
.SH NAME
ykval-checksum-deactivated - Calculate a checksum of deactivated YubiKeys
.SH SYNOPSIS
.B ykval-checksum-deactivated
.SH DESCRIPTION
Calculates a checksum of the state of all deactivated YubiKey Info data in the yubikey-val server database. This checksum can be used to easily compare the state of disabled YubiKeys in two yubikey-val servers in the same sync pool.
Database configuration is read from /etc/yubico/val/ykval-config.php
.SH BUGS
Report ykval-checksum-deactivated bugs in
.URL "https://github.com/Yubico/yubikey-val/issues" "the issue tracker"
.SH "SEE ALSO"
.BR ykval-checksum-clients (1)
The
.URL "https://github.com/Yubico/yubikey-val" "yubikey-val home page"
.PP
YubiKeys can be obtained from
.URL "http://www.yubico.com/" "Yubico" "."

55
ykval-export-clients.1 Normal file

@ -0,0 +1,55 @@
.\" Copyright (c) 2011-2013 Yubico AB
.\" 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.
.\"
.\" 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.
.\"
.\" The following commands are required for all man pages.
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.TH ykval-export-clients "1" "January 2013" "yubico-val"
.SH NAME
ykval-export-clients - Exports Client Info data from the yubikey-val server.
.SH SYNOPSIS
.B ykval-export-clients
.SH DESCRIPTION
Outputs a comma separated value file containing all Client Info from the
yubikey-val database. This data can later be imported using
ykval-import-clients.
Database configuration is read from /etc/yubico/val/ykval-config.php
.SH BUGS
Report ykval-export-clients bugs in
.URL "https://github.com/Yubico/yubikey-val/issues" "the issue tracker"
.SH "SEE ALSO"
.BR ykval-import-clients (1)
The
.URL "https://github.com/Yubico/yubikey-val/wiki/ClientInfoFormat" "Client Info data format"
.PP
YubiKeys can be obtained from
.URL "http://www.yubico.com/" "Yubico" "."

54
ykval-export.1 Normal file

@ -0,0 +1,54 @@
.\" Copyright (c) 2011-2013 Yubico AB
.\" 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.
.\"
.\" 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.
.\"
.\" The following commands are required for all man pages.
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.TH ykval-export "1" "January 2013" "yubico-val"
.SH NAME
ykval-export - Exports Yubikey Info data from the yubikey-val server.
.SH SYNOPSIS
.B ykval-export
.SH DESCRIPTION
Outputs comma separated values containing YubiKey Info formatted data from
the yubikey-val database. This data can later be imported using ykval-import.
Database configuration is read from /etc/yubico/val/ykval-config.php
.SH BUGS
Report ykval-export bugs in
.URL "https://github.com/Yubico/yubikey-val/issues" "the issue tracker"
.SH "SEE ALSO"
.BR ykval-import (1)
The
.URL "https://github.com/Yubico/yubikey-val/wiki/YubiKeyInfoFormat" "YubiKey Info data format"
.PP
YubiKeys can be obtained from
.URL "http://www.yubico.com/" "Yubico" "."

55
ykval-import-clients.1 Normal file

@ -0,0 +1,55 @@
.\" Copyright (c) 2011-2013 Yubico AB
.\" 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.
.\"
.\" 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.
.\"
.\" The following commands are required for all man pages.
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.TH ykval-import-clients "1" "January 2013" "yubico-val"
.SH NAME
ykval-import-clients - Imports Yubikey client data into the yubikey-val server.
.SH SYNOPSIS
.B ykval-import-clients
.SH DESCRIPTION
Reads yubikey-val Client Info data from stdin and imports it into the
yubikey-val servers database. Use ykval-export-clients to export data into
a suitable format.
Database configuration is read from /etc/yubico/val/ykval-config.php
.SH BUGS
Report ykval-import-clients bugs in
.URL "https://github.com/Yubico/yubikey-val/issues" "the issue tracker"
.SH "SEE ALSO"
.BR ykval-export-clients (1)
The
.URL "https://github.com/Yubico/yubikey-val/wiki/ClientInfoFormat" "Client Info data format"
.PP
YubiKeys can be obtained from
.URL "http://www.yubico.com/" "Yubico" "."

55
ykval-import.1 Normal file

@ -0,0 +1,55 @@
.\" Copyright (c) 2011-2013 Yubico AB
.\" 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.
.\"
.\" 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.
.\"
.\" The following commands are required for all man pages.
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.TH ykval-import "1" "January 2013" "yubico-val"
.SH NAME
ykval-import - Imports Yubikey Info data into the yubikey-val server.
.SH SYNOPSIS
.B ykval-import
.SH DESCRIPTION
Reads yubikey-val Yubikey Info data from stdin and imports it into the
yubikey-val servers database. The data should previously have been exported
using ykval-export.
Database configuration is read from /etc/yubico/val/ykval-config.php
.SH BUGS
Report ykval-import bugs in
.URL "https://github.com/Yubico/yubikey-val/issues" "the issue tracker"
.SH "SEE ALSO"
.BR ykval-export (1)
The
.URL "https://github.com/Yubico/yubikey-val/wiki/YubiKeyInfoFormat" "YubiKey Info data format"
.PP
YubiKeys can be obtained from
.URL "http://www.yubico.com/" "Yubico" "."

53
ykval-queue.1 Normal file

@ -0,0 +1,53 @@
.\" Copyright (c) 2011-2013 Yubico AB
.\" 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.
.\"
.\" 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.
.\"
.\" The following commands are required for all man pages.
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.TH ykval-queue "1" "January 2013" "yubico-val"
.SH NAME
ykval-queue - Sync servers in a yubikey-val sync pool.
.SH SYNOPSIS
.B ykval-queue
.SH DESCRIPTION
Periodically attempts to synchronize the Yubikey counter data with other
yubikey-val servers in the sync pool. Reads configuration from
/etc/yubico/val/ykval-config.php
This process is meant to be run as a daemon.
.SH BUGS
Report ykval-queue bugs in
.URL "https://github.com/Yubico/yubikey-val/issues" "the issue tracker"
.SH "SEE ALSO"
The
.URL "https://github.com/Yubico/yubikey-val" "yubikey-val home page"
.PP
YubiKeys can be obtained from
.URL "http://www.yubico.com/" "Yubico" "."