added test pkcsslotd-to-create-lock-and-log-directories

fixed variable reference
2021-04-21 14:14:06 +02:00 · 2021-02-08 10:28:17 +01:00
11 changed files with 1163 additions and 2 deletions
--- a/339
+++ b/339
@ -0,0 +1,339 @@
                    GNU GENERAL PUBLIC LICENSE
                       Version 2, June 1991
 Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.
                            Preamble
  The licenses for most software are designed to take away your
 freedom to share and change it.  By contrast, the GNU General Public
 License is intended to guarantee your freedom to share and change free
 software--to make sure the software is free for all its users.  This
 General Public License applies to most of the Free Software
 Foundation's software and to any other program whose authors commit to
 using it.  (Some other Free Software Foundation software is covered by
 the GNU Lesser General Public License instead.)  You can apply it to
 your programs, too.
  When we speak of free software, we are referring to freedom, not
 price.  Our General Public Licenses are designed to make sure that you
 have the freedom to distribute copies of free software (and charge for
 this service if you wish), that you receive source code or can get it
 if you want it, that you can change the software or use pieces of it
 in new free programs; and that you know you can do these things.
  To protect your rights, we need to make restrictions that forbid
 anyone to deny you these rights or to ask you to surrender the rights.
 These restrictions translate to certain responsibilities for you if you
 distribute copies of the software, or if you modify it.
  For example, if you distribute copies of such a program, whether
 gratis or for a fee, you must give the recipients all the rights that
 you have.  You must make sure that they, too, receive or can get the
 source code.  And you must show them these terms so they know their
 rights.
  We protect your rights with two steps: (1) copyright the software, and
 (2) offer you this license which gives you legal permission to copy,
 distribute and/or modify the software.
  Also, for each author's protection and ours, we want to make certain
 that everyone understands that there is no warranty for this free
 software.  If the software is modified by someone else and passed on, we
 want its recipients to know that what they have is not the original, so
 that any problems introduced by others will not reflect on the original
 authors' reputations.
  Finally, any free program is threatened constantly by software
 patents.  We wish to avoid the danger that redistributors of a free
 program will individually obtain patent licenses, in effect making the
 program proprietary.  To prevent this, we have made it clear that any
 patent must be licensed for everyone's free use or not licensed at all.
  The precise terms and conditions for copying, distribution and
 modification follow.
                    GNU GENERAL PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
  0. This License applies to any program or other work which contains
 a notice placed by the copyright holder saying it may be distributed
 under the terms of this General Public License.  The "Program", below,
 refers to any such program or work, and a "work based on the Program"
 means either the Program or any derivative work under copyright law:
 that is to say, a work containing the Program or a portion of it,
 either verbatim or with modifications and/or translated into another
 language.  (Hereinafter, translation is included without limitation in
 the term "modification".)  Each licensee is addressed as "you".
 Activities other than copying, distribution and modification are not
 covered by this License; they are outside its scope.  The act of
 running the Program is not restricted, and the output from the Program
 is covered only if its contents constitute a work based on the
 Program (independent of having been made by running the Program).
 Whether that is true depends on what the Program does.
  1. You may copy and distribute verbatim copies of the Program's
 source code as you receive it, in any medium, provided that you
 conspicuously and appropriately publish on each copy an appropriate
 copyright notice and disclaimer of warranty; keep intact all the
 notices that refer to this License and to the absence of any warranty;
 and give any other recipients of the Program a copy of this License
 along with the Program.
 You may charge a fee for the physical act of transferring a copy, and
 you may at your option offer warranty protection in exchange for a fee.
  2. You may modify your copy or copies of the Program or any portion
 of it, thus forming a work based on the Program, and copy and
 distribute such modifications or work under the terms of Section 1
 above, provided that you also meet all of these conditions:
    a) You must cause the modified files to carry prominent notices
    stating that you changed the files and the date of any change.
    b) You must cause any work that you distribute or publish, that in
    whole or in part contains or is derived from the Program or any
    part thereof, to be licensed as a whole at no charge to all third
    parties under the terms of this License.
    c) If the modified program normally reads commands interactively
    when run, you must cause it, when started running for such
    interactive use in the most ordinary way, to print or display an
    announcement including an appropriate copyright notice and a
    notice that there is no warranty (or else, saying that you provide
    a warranty) and that users may redistribute the program under
    these conditions, and telling the user how to view a copy of this
    License.  (Exception: if the Program itself is interactive but
    does not normally print such an announcement, your work based on
    the Program is not required to print an announcement.)
 These requirements apply to the modified work as a whole.  If
 identifiable sections of that work are not derived from the Program,
 and can be reasonably considered independent and separate works in
 themselves, then this License, and its terms, do not apply to those
 sections when you distribute them as separate works.  But when you
 distribute the same sections as part of a whole which is a work based
 on the Program, the distribution of the whole must be on the terms of
 this License, whose permissions for other licensees extend to the
 entire whole, and thus to each and every part regardless of who wrote it.
 Thus, it is not the intent of this section to claim rights or contest
 your rights to work written entirely by you; rather, the intent is to
 exercise the right to control the distribution of derivative or
 collective works based on the Program.
 In addition, mere aggregation of another work not based on the Program
 with the Program (or with a work based on the Program) on a volume of
 a storage or distribution medium does not bring the other work under
 the scope of this License.
  3. You may copy and distribute the Program (or a work based on it,
 under Section 2) in object code or executable form under the terms of
 Sections 1 and 2 above provided that you also do one of the following:
    a) Accompany it with the complete corresponding machine-readable
    source code, which must be distributed under the terms of Sections
    1 and 2 above on a medium customarily used for software interchange; or,
    b) Accompany it with a written offer, valid for at least three
    years, to give any third party, for a charge no more than your
    cost of physically performing source distribution, a complete
    machine-readable copy of the corresponding source code, to be
    distributed under the terms of Sections 1 and 2 above on a medium
    customarily used for software interchange; or,
    c) Accompany it with the information you received as to the offer
    to distribute corresponding source code.  (This alternative is
    allowed only for noncommercial distribution and only if you
    received the program in object code or executable form with such
    an offer, in accord with Subsection b above.)
 The source code for a work means the preferred form of the work for
 making modifications to it.  For an executable work, complete source
 code means all the source code for all modules it contains, plus any
 associated interface definition files, plus the scripts used to
 control compilation and installation of the executable.  However, as a
 special exception, the source code distributed need not include
 anything that is normally distributed (in either source or binary
 form) with the major components (compiler, kernel, and so on) of the
 operating system on which the executable runs, unless that component
 itself accompanies the executable.
 If distribution of executable or object code is made by offering
 access to copy from a designated place, then offering equivalent
 access to copy the source code from the same place counts as
 distribution of the source code, even though third parties are not
 compelled to copy the source along with the object code.
  4. You may not copy, modify, sublicense, or distribute the Program
 except as expressly provided under this License.  Any attempt
 otherwise to copy, modify, sublicense or distribute the Program is
 void, and will automatically terminate your rights under this License.
 However, parties who have received copies, or rights, from you under
 this License will not have their licenses terminated so long as such
 parties remain in full compliance.
  5. You are not required to accept this License, since you have not
 signed it.  However, nothing else grants you permission to modify or
 distribute the Program or its derivative works.  These actions are
 prohibited by law if you do not accept this License.  Therefore, by
 modifying or distributing the Program (or any work based on the
 Program), you indicate your acceptance of this License to do so, and
 all its terms and conditions for copying, distributing or modifying
 the Program or works based on it.
  6. Each time you redistribute the Program (or any work based on the
 Program), the recipient automatically receives a license from the
 original licensor to copy, distribute or modify the Program subject to
 these terms and conditions.  You may not impose any further
 restrictions on the recipients' exercise of the rights granted herein.
 You are not responsible for enforcing compliance by third parties to
 this License.
  7. If, as a consequence of a court judgment or allegation of patent
 infringement or for any other reason (not limited to patent issues),
 conditions are imposed on you (whether by court order, agreement or
 otherwise) that contradict the conditions of this License, they do not
 excuse you from the conditions of this License.  If you cannot
 distribute so as to satisfy simultaneously your obligations under this
 License and any other pertinent obligations, then as a consequence you
 may not distribute the Program at all.  For example, if a patent
 license would not permit royalty-free redistribution of the Program by
 all those who receive copies directly or indirectly through you, then
 the only way you could satisfy both it and this License would be to
 refrain entirely from distribution of the Program.
 If any portion of this section is held invalid or unenforceable under
 any particular circumstance, the balance of the section is intended to
 apply and the section as a whole is intended to apply in other
 circumstances.
 It is not the purpose of this section to induce you to infringe any
 patents or other property right claims or to contest validity of any
 such claims; this section has the sole purpose of protecting the
 integrity of the free software distribution system, which is
 implemented by public license practices.  Many people have made
 generous contributions to the wide range of software distributed
 through that system in reliance on consistent application of that
 system; it is up to the author/donor to decide if he or she is willing
 to distribute software through any other system and a licensee cannot
 impose that choice.
 This section is intended to make thoroughly clear what is believed to
 be a consequence of the rest of this License.
  8. If the distribution and/or use of the Program is restricted in
 certain countries either by patents or by copyrighted interfaces, the
 original copyright holder who places the Program under this License
 may add an explicit geographical distribution limitation excluding
 those countries, so that distribution is permitted only in or among
 countries not thus excluded.  In such case, this License incorporates
 the limitation as if written in the body of this License.
  9. The Free Software Foundation may publish revised and/or new versions
 of the General Public License from time to time.  Such new versions will
 be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
 Each version is given a distinguishing version number.  If the Program
 specifies a version number of this License which applies to it and "any
 later version", you have the option of following the terms and conditions
 either of that version or of any later version published by the Free
 Software Foundation.  If the Program does not specify a version number of
 this License, you may choose any version ever published by the Free Software
 Foundation.
  10. If you wish to incorporate parts of the Program into other free
 programs whose distribution conditions are different, write to the author
 to ask for permission.  For software which is copyrighted by the Free
 Software Foundation, write to the Free Software Foundation; we sometimes
 make exceptions for this.  Our decision will be guided by the two goals
 of preserving the free status of all derivatives of our free software and
 of promoting the sharing and reuse of software generally.
                            NO WARRANTY
  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
 REPAIR OR CORRECTION.
  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
                     END OF TERMS AND CONDITIONS
            How to Apply These Terms to Your New Programs
  If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it
 free software which everyone can redistribute and change under these terms.
  To do so, attach the following notices to the program.  It is safest
 to attach them to the start of each source file to most effectively
 convey the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 Also add information on how to contact you by electronic and paper mail.
 If the program is interactive, make it output a short notice like this
 when it starts in an interactive mode:
    Gnomovision version 69, Copyright (C) year name of author
    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.
 The hypothetical commands `show w' and `show c' should show the appropriate
 parts of the General Public License.  Of course, the commands you use may
 be called something other than `show w' and `show c'; they could even be
 mouse-clicks or menu items--whatever suits your program.
 You should also get your employer (if you work as a programmer) or your
 school, if any, to sign a "copyright disclaimer" for the program, if
 necessary.  Here is a sample; alter the names:
  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
  `Gnomovision' (which makes passes at compilers) written by James Hacker.
  <signature of Ty Coon>, 1 April 1989
  Ty Coon, President of Vice
 This General Public License does not permit incorporating your program into
 proprietary programs.  If your program is a subroutine library, you may
 consider it more useful to permit linking proprietary applications with the
 library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.
--- a/Library/token-manipulation/lib.sh
+++ b/Library/token-manipulation/lib.sh
@ -0,0 +1,343 @@
 #!/bin/bash
 # vim: dict+=/usr/share/beakerlib/dictionary.vim cpt=.,w,b,u,t,i,k
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 #   lib.sh of /CoreOS/opencryptoki/Library/token-manipulation
 #   Description: provides basic function for token manipulation
 #   Author: Karel Srot <ksrot@redhat.com>
 #
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 #   Copyright (c) 2020 Red Hat, Inc.
 #
 #   This copyrighted material is made available to anyone wishing
 #   to use, modify, copy, or redistribute it subject to the terms
 #   and conditions of the GNU General Public License version 2.
 #
 #   This program is distributed in the hope that it will be
 #   useful, but WITHOUT ANY WARRANTY; without even the implied
 #   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 #   PURPOSE. See the GNU General Public License for more details.
 #
 #   You should have received a copy of the GNU General Public
 #   License along with this program; if not, write to the Free
 #   Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 #   Boston, MA 02110-1301, USA.
 #
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #   library-prefix = pkcs
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 true <<'=cut'
 =pod
 =head1 NAME
 opencryptoki/token-manipulation - provides basic function for token manipulation
 =head1 DESCRIPTION
 The library provides basic function for manipulation with
 opencryptoki tokens, like initialization, cleanup etc.
 =cut
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #   Variables
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 true <<'=cut'
 =pod
 =head1 VARIABLES
 Below is the list of global variables. When writing a new library,
 please make sure that all global variables start with the library
 prefix to prevent collisions with other libraries.
 =over
 =item pkcsUSER_PIN
 USER PIN to be used when initializing a token. By default 01234567.
 =item pkcsSO_PIN
 SO PIN to be used when initializing a token. By default 76543210.
 =item pkcsFACTORY_SO_PIN
 Default (factory) SO PIN of a token. Initialized as 87654321.
 =back
 =cut
 export pkcsUSER_PIN
 [ -n "$pkcsUSER_PIN" ] || pkcsUSER_PIN="01234567"
 export pkcsSO_PIN
 [ -n "$pkcsSO_PIN" ] || pkcsSO_PIN="76543210"
 export pkcsFACTORY_SO_PIN
 [ -n "$pkcsFACTORY_SO_PIN" ] || pkcsFACTORY_SO_PIN="87654321"
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #   Functions
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 true <<'=cut'
 =pod
 =head1 FUNCTIONS
 =head2 pkcsGetTokenSlot
 Return slot number for a token with specified type.
    pkcsGetTokenSlot type
 =over
 =item type
 Token type to be used. Available options are matching
 dynamic library suffixes from /etc/opencryptoki/opencryptoki.conf,
 in particular : sw, tpm, ica, cca, ep11
 =back
 Returns 0 when the initialization was successfull, non-zero otherwise.
 =cut
 pkcsGetTokenSlot() {
    local TYPE=$1
    local CONF=/etc/opencryptoki/opencryptoki.conf
    local SLOT
    [ -z "$TYPE" ] && echo "Error: pkcsGetTokenSlot: no token type specified" && return 1
    if grep -q "^stdll = libpkcs11_$TYPE.so" $CONF; then
        SLOT=$( egrep "^(slot|stdll = libpkcs11_$TYPE.so)" $CONF | grep -B 1 "libpkcs11" | sed -n -e '1,1 s/slot //' -e '1,1 p' )
 	echo $SLOT
    else
        echo "Error: pkcsGetTokenSlot: could not find type $TYPE in $CONF"
        return 1
    fi
 }
 true <<'=cut'
 =pod
 =head2 pkcsInitToken
 Initialize token specified using slot number and sets up
 new SO PIN and USER PIN.
    pkcsInitToken type|slot [CURRENT_SO_PIN]
 =over
 =item type
 Token specification using the token type.
 Available options are: sw, tpm, ica, cca, ep11.
 =item slot
 Token specification using the slot number.
 =back
 Returns 0 when the initialization was successfull, non-zero otherwise.
 =cut
 pkcsInitToken() {
    local SLOT
    local LABEL="$2"
    [ -z $1 ] && echo "Error: pkcsInitToken: No token type specified"
    # if token specified using slot number
    if echo "$1" | grep -qE '^[0-9]+$'; then
        SLOT=$1
    else  # specified using token type
        SLOT=$( pkcsGetTokenSlot $1 ) || return 1
    fi
    echo SLOT: $SLOT
    # if label not specified, use the current value
    [ -z "$LABEL" ] && LABEL=`pkcsconf -t -c $SLOT | grep 'Label:' | sed 's/^.*Label: //'`
    echo LABEL: $LABEL
    local SOPIN=$2
    [ -z $SOPIN ] && SOPIN=$pkcsFACTORY_SO_PIN
    echo "pkcsInitToken: Initialize token"
    cat <<EOF | expect
 spawn /usr/sbin/pkcsconf -c $SLOT -I
 expect "Enter the SO PIN: "
 sleep .1
 send "${SOPIN}\r"
 sleep .1
 expect "label: "
 sleep .1
 send "${LABEL}\r"
 sleep .1
 expect eof {} \
 "Incorrect PIN Entered." {exit 1}
 exit 0
 EOF
    echo "pkcsInitToken: Changing SO PIN"
    cat <<EOF | expect
 spawn /usr/sbin/pkcsconf -c $SLOT -P
 expect "Enter the SO PIN: "
 sleep .1
 send "${SOPIN}\r"
 sleep .1
 expect "Enter the new SO PIN: "
 sleep .1
 send "$pkcsSO_PIN\r"
 sleep .1
 expect "Re-enter the new SO PIN: "
 sleep .1
 send "$pkcsSO_PIN\r"
 sleep .1
 expect " " {exit 1}
 exit 0
 EOF
    if [ $? -eq 0 ]; then
        echo "pkcsInitToken: Succesfully changed SO PIN to $pkcsSO_PIN"
    else
        echo "Error: pkcsInitToken: Failed to change SO PIN"
        return 1
    fi
    echo "pkcsInitToken: Changing USER PIN"
    cat <<EOF | expect
 spawn /usr/sbin/pkcsconf -c $SLOT -u
 expect "Enter the SO PIN: "
 sleep .1
 send "$pkcsSO_PIN\r"
 sleep .1
 expect "Enter the new user PIN: "
 sleep .1
 send "$pkcsUSER_PIN\r"
 sleep .1
 expect "Re-enter the new user PIN: "
 sleep .1
 send "$pkcsUSER_PIN\r"
 sleep .1
 expect " " {exit 1}
 exit 0
 EOF
    if [ $? -eq 0 ]; then
        echo "pkcsInitToken: Succesfully changed USER PIN to $pkcsUSER_PIN"
    else
        echo "Error: pkcsInitToken: Failed to change USER PIN"
        return 1
    fi
 }
 true <<'=cut'
 =pod
 =head2 pkcsResetTokens
 Makes a backup of /var/lib/opencryptoki and resets all tokens 
 by removing all files from /var/lib/opencryptoki and shared 
 memory files from /dev/shm.
 =back
 Returns 0 if the backup and removal passed, non-zero otherwise.
 =cut
 pkcsResetTokens() {
    rlFileBackup --clean --namespace pkcslib /var/lib/opencryptoki && \
    find /var/lib/opencryptoki/ -type f -exec rm {} \; && \
    rm -f /dev/shm/var.lib.opencryptoki.*
 }
 true <<'=cut'
 =pod
 =head2 pkcsRestoreTokens
 Restores a backup of /var/lib/opencryptoki created in pkcsResetTokens().
 =back
 Returns 0 if the backup restore passed.
 =cut
 pkcsRestoreTokens() {
    rlFileRestore --namespace pkcslib
 }
 true <<'=cut'
 =pod
 =head1 EXECUTION
 This library supports direct execution. When run as a task, phases
 provided in the PHASE environment variable will be executed.
 Supported phases are:
 =over
 =item Create
 Create a new empty file. Use FILENAME to provide the desired file
 name. By default 'foo' is created in the current directory.
 =item Test
 Run the self test suite.
 =back
 =cut
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #   Verification
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 #   This is a verification callback which will be called by
 #   rlImport after sourcing the library to make sure everything is
 #   all right. It makes sense to perform a basic sanity test and
 #   check that all required packages are installed. The function
 #   should return 0 only when the library is ready to serve.
 pkcsLibraryLoaded() {
    if rpm=$(rpm -q opencryptoki); then
        rlLogDebug "Librar opencryptoki/token-manipulation running with $rpm"
        return 0
    else
        rlLogError "Package opencryptoki not installed"
        return 1
    fi
 }
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #   Authors
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 true <<'=cut'
 =pod
 =head1 AUTHORS
 =over
 =item *
 Karel Srot <ksrot@redhat.com>
 =back
 =cut
--- a/Library/token-manipulation/main.fmf
+++ b/Library/token-manipulation/main.fmf
@ -0,0 +1,19 @@
 summary: provides basic function for token manipulation
 description: ''
 contact: Karel Srot <ksrot@redhat.com>
 component: []
 test: ./runtest.sh
 framework: beakerlib
 recommend:
 - opencryptoki
 - opencryptoki-swtok
 - expect
 duration: 5m
 enabled: true
 adjust:
 -   enabled: false
    when: distro == rhel-4, rhel-5, rhel-6
    continue: false
 extra-nitrate: TC#0607908
 extra-summary: '[pkcs] provides basic function for token manipulation (opencryptoki/token-manipulation)'
 extra-task: /CoreOS/opencryptoki/Library/token-manipulation
--- a/Library/token-manipulation/runtest.sh
+++ b/Library/token-manipulation/runtest.sh
@ -0,0 +1,62 @@
 #!/bin/bash
 # vim: dict+=/usr/share/beakerlib/dictionary.vim cpt=.,w,b,u,t,i,k
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 #   runtest.sh of /CoreOS/opencryptoki/Library/token-manipulation
 #   Description: provides basic function for token manipulation
 #   Author: Karel Srot <ksrot@redhat.com>
 #
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 #   Copyright (c) 2020 Red Hat, Inc.
 #
 #   This copyrighted material is made available to anyone wishing
 #   to use, modify, copy, or redistribute it subject to the terms
 #   and conditions of the GNU General Public License version 2.
 #
 #   This program is distributed in the hope that it will be
 #   useful, but WITHOUT ANY WARRANTY; without even the implied
 #   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 #   PURPOSE. See the GNU General Public License for more details.
 #
 #   You should have received a copy of the GNU General Public
 #   License along with this program; if not, write to the Free
 #   Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 #   Boston, MA 02110-1301, USA.
 #
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Include Beaker environment
 . /usr/share/beakerlib/beakerlib.sh || exit 1
 PACKAGE="opencryptoki"
 PHASE=${PHASE:-Test}
 rlJournalStart
    rlPhaseStartSetup
        rlRun "rlImport ./token-manipulation"
        rlRun "TmpDir=\$(mktemp -d)" 0 "Creating tmp directory"
        rlRun "pushd $TmpDir"
    rlPhaseEnd
    # Self test
    if [[ "$PHASE" =~ "Test" ]]; then
        rlPhaseStartTest "Test sw token initialization"
 	    rlServiceStop pkcsslotd
            pkcsResetTokens
 	    rlServiceStart pkcsslotd
            pkcsInitToken sw
 	    rlRun -s "pkcsconf -t"
 	    rlAssertGrep "USER_PIN_INITIALIZED" $rlRun_LOG
 	    rlServiceStop pkcsslotd
            pkcsRestoreTokens
 	    rlServiceRestore pkcsslotd
        rlPhaseEnd
    fi
    rlPhaseStartCleanup
        rlRun "popd"
        rlRun "rm -r $TmpDir" 0 "Removing tmp directory"
    rlPhaseEnd
 rlJournalPrintText
 rlJournalEnd
--- a/README.md
+++ b/README.md
@ -1,2 +1,3 @@
-Tests have been moved to a RH internal GitLab CEE instance
+# opencryptoki
-/rhel-tests/opencryptoki
+
 tests for the opencryptoki package
--- a/Sanity/init-token-as-a-nonroot-user/main.fmf
+++ b/Sanity/init-token-as-a-nonroot-user/main.fmf
@ -0,0 +1,36 @@
 summary: basic token initialization as a nonroot user
 description: basic token initialization as a nonroot user
 contact: Karel Srot <ksrot@redhat.com>
 component:
 - openCryptoki
 test: ./runtest.sh
 framework: beakerlib
 require:
 - library(nvr/nvr)
 - url: https://src.fedoraproject.org/tests/opencryptoki.git
  name: /Library/token-manipulation
 recommend:
 - opencryptoki
 - opencryptoki-swtok
 - opencryptoki-tpmtok
 - opencryptoki-ccatok
 - opencryptoki-icsftok
 - opencryptoki-icatok
 - expect
 duration: 5m
 enabled: true
 tag:
 - CI-Tier-1
 - NoRHEL4
 - NoRHEL5
 - TIPpass_Security
 - Tier1
 - Tier1security
 tier: '1'
 adjust:
 -   enabled: false
    when: distro == rhel-4, rhel-5
    continue: false
 extra-nitrate: TC#0342770
 extra-summary: /CoreOS/openCryptoki/Sanity/bz1054661-init-token-as-a-nonroot-user
 extra-task: /CoreOS/openCryptoki/Sanity/bz1054661-init-token-as-a-nonroot-user
--- a/Sanity/init-token-as-a-nonroot-user/runtest.sh
+++ b/Sanity/init-token-as-a-nonroot-user/runtest.sh
@ -0,0 +1,86 @@
 #!/bin/bash
 # vim: dict=/usr/share/beakerlib/dictionary.vim cpt=.,w,b,u,t,i,k
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 #   runtest.sh of /CoreOS/openCryptoki/Sanity/bz1054661-init-token-as-a-nonroot-user
 #   Description: basic token initialization as a nonroot user
 #   Author: Karel Srot <ksrot@redhat.com>
 #
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 #   Copyright (c) 2014 Red Hat, Inc.
 #
 #   This copyrighted material is made available to anyone wishing
 #   to use, modify, copy, or redistribute it subject to the terms
 #   and conditions of the GNU General Public License version 2.
 #
 #   This program is distributed in the hope that it will be
 #   useful, but WITHOUT ANY WARRANTY; without even the implied
 #   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 #   PURPOSE. See the GNU General Public License for more details.
 #
 #   You should have received a copy of the GNU General Public
 #   License along with this program; if not, write to the Free
 #   Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 #   Boston, MA 02110-1301, USA.
 #
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Include Beaker environment
 . /usr/share/beakerlib/beakerlib.sh || exit 1
 PACKAGE="opencryptoki"
 USER="user$RANDOM"
 TESTDIR=`pwd`
 rlJournalStart
    rlPhaseStartSetup
        rlRun "rlImport nvr/nvr" || rlDie "cannot import distribution/nvr library"
 	# need to find out the library path so a user can import it too
 	rlRun "rlImport opencryptoki/token-manipulation" 2> import.log || rlDie "Could not import opencryptoki/token-manipulation library"
 	LIBPATH=`grep 'Will try to import opencryptoki\/token-manipulation from' import.log | sed 's/^.*token-manipulation from//'`
 	echo "LIBPATH=$LIBPATH"
        rlAssertRpm $PACKAGE
        rlRun "TmpDir=\$(mktemp -d)" 0 "Creating tmp directory"
        rlRun "pushd $TmpDir"
 	rlRun "useradd -m $USER -G pkcs11"
 	rlServiceStop pkcsslotd
 	rlRun "pkcsResetTokens"
 	rlServiceStart pkcsslotd
    rlPhaseEnd
    rlPhaseStartTest "listing available tokens as a testuser"
 	rlRun "su $USER -c 'pkcsconf -t' &> query1.log"
 	cat query1.log
    if nvrTestPackage opencryptoki '<' 3.14.0; then
 	    rlAssertGrep "Model: IBM SoftTok" query1.log
    else
        rlAssertGrep "Model: Soft " query1.log
    fi
    rlPhaseEnd
  # initialize every token available
  for SLOT in `sed -n 's/^Token #\([0-9]\).*/\1/gp' query1.log`; do
    rlPhaseStartTest "initialize token #$SLOT"
 	rlRun "su $USER -c 'source $LIBPATH && pkcsInitToken $SLOT'"
 	rlRun "su $USER -c 'pkcsconf -t -c $SLOT' &> query2.log"
 	cat query2.log
 	rlAssertGrep 'Flags:.*LOGIN_REQUIRED.*USER_PIN_INITIALIZED.*TOKEN_INITIALIZED' query2.log -E
    rlPhaseEnd
  done
    rlPhaseStartCleanup
 	rlServiceStop pkcsslotd
 	rlRun "pkcsRestoreTokens"
 	    rlServiceRestore pkcsslotd
        rlRun "popd"
        rlRun "rm -r $TmpDir" 0 "Removing tmp directory"
        rlLog "Waiting 12 for systemd --user process to exit..."
        sleep 15
        rlRun "userdel -r $USER" || ps -ef
    rlPhaseEnd
 rlJournalPrintText
 rlJournalEnd
--- a/Sanity/init-tokens-as-root/main.fmf
+++ b/Sanity/init-tokens-as-root/main.fmf
@ -0,0 +1,39 @@
 summary: Initialize all available tokens as a root user
 description: |
    Bugzilla link: https://bugzilla.redhat.com/show_bug.cgi?id=1122505
 contact: Karel Srot <ksrot@redhat.com>
 component:
 - openCryptoki
 test: ./runtest.sh
 framework: beakerlib
 require:
 - library(nvr/nvr)
 - url: https://src.fedoraproject.org/tests/opencryptoki.git
  name: /Library/token-manipulation
 recommend:
 - opencryptoki
 - opencryptoki-swtok
 - opencryptoki-tpmtok
 - opencryptoki-ccatok
 - opencryptoki-icsftok
 - opencryptoki-icatok
 - expect
 duration: 5m
 enabled: true
 tag:
 - CI-Tier-1
 - NoRHEL4
 - NoRHEL5
 - TIPpass_FIPS
 - TIPpass_Security
 - Tier1
 - Tier1security
 - TierCandidatesPASS
 tier: '1'
 adjust:
 -   enabled: false
    when: distro == rhel-4, rhel-5, rhel-6
    continue: false
 extra-nitrate: TC#0470488
 extra-summary: /CoreOS/opencryptoki/Sanity/init-tokens-as-root
 extra-task: /CoreOS/opencryptoki/Sanity/init-tokens-as-root
--- a/Sanity/init-tokens-as-root/runtest.sh
+++ b/Sanity/init-tokens-as-root/runtest.sh
@ -0,0 +1,77 @@
 #!/bin/bash
 # vim: dict+=/usr/share/beakerlib/dictionary.vim cpt=.,w,b,u,t,i,k
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 #   runtest.sh of /CoreOS/opencryptoki/Sanity/init-tokens-as-root
 #   Description: Test for BZ#1122505 (opencryptoki sw token no longer found after rebase)
 #   Author: Karel Srot <ksrot@redhat.com>
 #
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 #   Copyright (c) 2015 Red Hat, Inc.
 #
 #   This copyrighted material is made available to anyone wishing
 #   to use, modify, copy, or redistribute it subject to the terms
 #   and conditions of the GNU General Public License version 2.
 #
 #   This program is distributed in the hope that it will be
 #   useful, but WITHOUT ANY WARRANTY; without even the implied
 #   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 #   PURPOSE. See the GNU General Public License for more details.
 #
 #   You should have received a copy of the GNU General Public
 #   License along with this program; if not, write to the Free
 #   Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 #   Boston, MA 02110-1301, USA.
 #
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Include Beaker environment
 . /usr/share/beakerlib/beakerlib.sh || exit 1
 PACKAGE="opencryptoki"
 TESTDIR=`pwd`
 rlJournalStart
    rlPhaseStartSetup
        rlRun "rlImport nvr/nvr" || rlDie "cannot import distribution/nvr library"
 		rlRun "rlImport opencryptoki/token-manipulation" || rlDie "Could not import opencryptoki/token-manipulation library"
        rlAssertRpm $PACKAGE
        rlRun "TmpDir=\$(mktemp -d)" 0 "Creating tmp directory"
        rlRun "pushd $TmpDir"
 		rlServiceStop pkcsslotd
        rlRun "pkcsResetTokens"
        rlRun "id root | grep pkcs11" 1 "Verify that root is not in pkcs11 group"
 		rlServiceStart pkcsslotd
    rlPhaseEnd
    rlPhaseStartTest "listing available tokens as root"
        rlRun "pkcsconf -t &> query1.log"
        cat query1.log
        if nvrTestPackage opencryptoki '<' 3.14.0; then
            rlAssertGrep "Model: IBM SoftTok" query1.log
        else
            rlAssertGrep "Model: Soft " query1.log
        fi
    rlPhaseEnd
  # initialize every token available
  for SLOT in `sed -n 's/^Token #\([0-9]\).*/\1/gp' query1.log`; do
    rlPhaseStartTest "initialize token #$SLOT as root"
        rlRun "pkcsInitToken $SLOT"
        rlRun "pkcsconf -t -c $SLOT &> query2.log"
        cat query2.log
        rlAssertGrep 'Flags:.*LOGIN_REQUIRED.*USER_PIN_INITIALIZED.*TOKEN_INITIALIZED' query2.log -E
    rlPhaseEnd
  done
    rlPhaseStartCleanup
        rlRun "popd"
        rlRun "rm -r $TmpDir" 0 "Removing tmp directory"
 		rlServiceStop pkcsslotd
        rlRun "pkcsRestoreTokens"
        rlServiceRestore pkcsslotd
    rlPhaseEnd
 rlJournalPrintText
 rlJournalEnd
--- a/Sanity/pkcsslotd-to-create-lock-and-log-directories/main.fmf
+++ b/Sanity/pkcsslotd-to-create-lock-and-log-directories/main.fmf
@ -0,0 +1,48 @@
 summary: Test for BZ#1343671 (RHEL7.3 - patch to create lock and log directories)
 description: |
    Bug summary: RHEL7.3 - patch to create lock and log directories from opencryptoki
    Bugzilla link: https://bugzilla.redhat.com/show_bug.cgi?id=1343671
 contact: Karel Srot <ksrot@redhat.com>
 component:
 - openCryptoki
 test: ./runtest.sh
 framework: beakerlib
 require:
 #- library(distribution/nvr)
 - url: https://github.com/beakerlib/nvr.git
  name: /nvr
 - url: https://src.fedoraproject.org/tests/opencryptoki.git
  name: /Library/token-manipulation
 recommend:
 - opencryptoki
 - opencryptoki-swtok
 - opencryptoki-tpmtok
 - opencryptoki-ccatok
 - opencryptoki-icsftok
 - opencryptoki-icatok
 - expect
 - libselinux-utils
 - policycoreutils
 duration: 5m
 enabled: true
 tag:
 - CI-Tier-1
 - NoRHEL4
 - NoRHEL5
 - NoRHEL6
 - TIPpass_Security
 - Tier1
 - Tier1security
 - TierCandidatesPASS
 tier: '1'
 link:
 -   relates: https://bugzilla.redhat.com/show_bug.cgi?id=1343671
 -   relates: https://bugzilla.redhat.com/show_bug.cgi?id=1373833
 -   relates: https://bugzilla.redhat.com/show_bug.cgi?id=1697489
 adjust:
 -   enabled: false
    when: distro == rhel-4, rhel-5, rhel-6
    continue: false
 extra-nitrate: TC#0532369
 extra-summary: /CoreOS/opencryptoki/Sanity/pkcsslotd-to-create-lock-and-log-directories
 extra-task: /CoreOS/opencryptoki/Sanity/pkcsslotd-to-create-lock-and-log-directories
--- a/Sanity/pkcsslotd-to-create-lock-and-log-directories/runtest.sh
+++ b/Sanity/pkcsslotd-to-create-lock-and-log-directories/runtest.sh
@ -0,0 +1,111 @@
 #!/bin/bash
 # vim: dict+=/usr/share/beakerlib/dictionary.vim cpt=.,w,b,u,t,i,k
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 #   runtest.sh of /CoreOS/opencryptoki/Sanity/pkcsslotd-to-create-lock-and-log-directories
 #   Description: Test for BZ#1343671 (RHEL7.3 - patch to create lock and log directories)
 #   Author: Karel Srot <ksrot@redhat.com>
 #
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 #   Copyright (c) 2016 Red Hat, Inc.
 #
 #   This copyrighted material is made available to anyone wishing
 #   to use, modify, copy, or redistribute it subject to the terms
 #   and conditions of the GNU General Public License version 2.
 #
 #   This program is distributed in the hope that it will be
 #   useful, but WITHOUT ANY WARRANTY; without even the implied
 #   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 #   PURPOSE. See the GNU General Public License for more details.
 #
 #   You should have received a copy of the GNU General Public
 #   License along with this program; if not, write to the Free
 #   Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 #   Boston, MA 02110-1301, USA.
 #
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Include Beaker environment
 . /usr/share/beakerlib/beakerlib.sh || exit 1
 PACKAGE="opencryptoki"
 USER="bz1343671user"
 TESTDIR=`pwd`
 LOCKDIR=/run/lock  # see bz#1373833
 rlIsRHEL '<7' && LOCKDIR=/var/lock
 rlJournalStart
    rlPhaseStartSetup
        rlAssertRpm $PACKAGE
        rlRun "rlImport nvr" || rlDie "cannot import nvr library"
        rlRun "rlImport opencryptoki/token-manipulation" 2> import.log || rlDie "Could not import opencryptoki/token-manipulation library"
        # need library path so we can import it as a test user
        LIBPATH=`grep 'Will try to import opencryptoki\/token-manipulation from' import.log | sed 's/^.*token-manipulation from//'`
    echo "LIBPATH=$LIBPATH"
        rlRun "TmpDir=\$(mktemp -d)" 0 "Creating tmp directory"
        rlRun "pushd $TmpDir"
 	    rlServiceStop pkcsslotd
        rlFileBackup --clean /var/lib/opencryptoki /var/log/opencryptoki $LOCKDIR/opencryptoki
        # avoid using /var/lock symlink to properly test bug 1373833
 	    if [ "$LOCKDIR" == "/run/lock" ]; then
 		    [ -L /var/lock ] && rlFileBackup /var/lock && rlRun "rm -f /var/lock"
 	    fi
        rlRun "useradd -m $USER -G pkcs11"
    rlPhaseEnd
    rlPhaseStartTest "testing directory creation during pkcsslotd start"
 	    rlRun "rm -rf /var/log/opencryptoki $LOCKDIR/opencryptoki"
 	    rlRun "pkcsResetTokens"
        rlServiceStart pkcsslotd
 	    rlAssertExists /var/log/opencryptoki
 	    rlAssertExists $LOCKDIR/opencryptoki
 	    rlRun "matchpathcon /var/log/opencryptoki"
 	    rlRun "matchpathcon $LOCKDIR/opencryptoki"
 	    rlRun "su $USER -c 'pkcsconf -t' &> query1.log"
        cat query1.log
        if nvrTestPackage opencryptoki '<' 3.14.0; then
 	        rlAssertGrep "Model: IBM SoftTok" query1.log
        else
            rlAssertGrep "Model: Soft " query1.log
        fi
    rlPhaseEnd
    # initialize every token available
    for SLOT in `sed -n 's/^Token #\([0-9]\).*/\1/gp' query1.log`; do
        rlPhaseStartTest "initialize token #$SLOT"
 	    	rlRun "su $USER -c 'source $LIBPATH && pkcsInitToken $SLOT'"
 	    	rlRun "su $USER -c 'pkcsconf -t -c $SLOT' &> query2.log"
 	    	cat query2.log
 	    	rlAssertGrep 'Flags:.*LOGIN_REQUIRED.*USER_PIN_INITIALIZED.*TOKEN_INITIALIZED' query2.log -E
        rlPhaseEnd
    done
  if [ "$LOCKDIR" == "/run/lock" ]; then
    rlPhaseStartTest "checking there is no /var/lock in filelist"
        rlRun "rpm -ql $(rpm -qa | grep opencryptoki | tr '\n' ' ') | grep /var/lock" 1
    rlPhaseEnd
  fi
    rlPhaseStartTest "checking $LOCKDIR/opencryptoki selinux contexts"
 	    rlRun -s "restorecon -Rnv $LOCKDIR/opencryptoki"
 	    rlAssertNotGrep "restorecon reset" $rlRun_LOG
    rlPhaseEnd
    rlPhaseStartCleanup
        rlRun "popd"
        rlRun "rm -r $TmpDir" 0 "Removing tmp directory"
 	    rlFileRestore
        rlRun "pkcsRestoreTokens"
 	    rlServiceRestore pkcsslotd
        rlLog "Waiting 12 sec for systemd --user process to exit..."
        sleep 12
        rlRun "userdel -r $USER" || ps -ef
    rlPhaseEnd
 rlJournalPrintText
 rlJournalEnd
Author	SHA1	Message	Date
Karel Srot	05a9bfc77d	added test pkcsslotd-to-create-lock-and-log-directories	2021-04-21 14:14:06 +02:00
Karel Srot	e5d68caa01	fixed variable reference	2021-02-08 10:28:17 +01:00