490 lines
23 KiB
HTML
490 lines
23 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html lang="en-us" xml:lang="en-us">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="security" content="public" />
|
|
<meta name="Robots" content="index,follow" />
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
|
<meta name="DC.Type" content="reference" />
|
|
<meta name="DC.Title" content="Example: ILE RPG program for installing a master key share" />
|
|
<meta name="abstract" content="Change this program example to suit your needs for installing a master key share." />
|
|
<meta name="description" content="Change this program example to suit your needs for installing a master key share." />
|
|
<meta name="DC.Relation" scheme="URI" content="rzajcworking.htm" />
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2006" />
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2006" />
|
|
<meta name="DC.Format" content="XHTML" />
|
|
<meta name="DC.Identifier" content="putsharerpg" />
|
|
<meta name="DC.Language" content="en-us" />
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
|
<title>Example: ILE RPG program for installing a master key share</title>
|
|
</head>
|
|
<body id="putsharerpg"><a name="putsharerpg"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">Example: ILE RPG program for installing a master key share</h1>
|
|
<div><p>Change this program example to suit your needs for installing a
|
|
master key share.</p>
|
|
<div class="section"><div class="p"> <div class="note"><span class="notetitle">Note:</span> Read the <a href="codedisclaimer.htm#codedisclaimer">Code license and disclaimer information</a> for
|
|
important legal information.</div>
|
|
</div>
|
|
</div>
|
|
<div class="example"> <pre> D*************************************************************
|
|
D* PUTSHARE
|
|
D*
|
|
D* Sample program to install a master key share as part of
|
|
D* the master key cloning process.
|
|
D*
|
|
D*
|
|
D* COPYRIGHT 5769-SS1 (C) IBM CORP. 2000, 2000
|
|
D*
|
|
D* This material contains programming source code for your
|
|
D* consideration. These example has not been thoroughly
|
|
D* tested under all conditions. IBM, therefore, cannot
|
|
D* guarantee or imply reliability, serviceability, or function
|
|
D* of these programs. All programs contained herein are
|
|
D* provided to you "AS IS". THE IMPLIED WARRANTIES OF
|
|
D* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
D* ARE EXPRESSLY DISCLAIMED. IBM provides no program services for
|
|
D* these programs and files.
|
|
D*
|
|
D*
|
|
D* Note: Input format is more fully described in Chapter 2 of
|
|
D* IBM CCA Basic Services Reference and Guide
|
|
D* (SC31-8609) publication.
|
|
D*
|
|
D* Parameters: Share number
|
|
D* Name of share receiver private key
|
|
D* Name of certifying key
|
|
D* Path name of stream file containing sender certificate
|
|
D*
|
|
D* Example:
|
|
D* CALL PGM(PUTSHARE) PARM(2 RECVR SAKEY SENDER.PUB)
|
|
D*
|
|
D* Use these commands to compile this program on the system:
|
|
D* CRTRPGMOD MODULE(PUTSHARE) SRCFILE(SAMPLE)
|
|
D* CRTPGM PGM(PUTSHARE) MODULE(PUTSHARE)
|
|
D* BNDDIR(QCCA/QC6BNDDIR)
|
|
D*
|
|
D* Note: Authority to the CSUAMKD service program
|
|
D* in the QCCA library is assumed.
|
|
D*
|
|
D* The Common Cryptographic Architecture (CCA) verbs used is
|
|
D* Master_Key_Distribution (CSUAMKD).
|
|
D*
|
|
D**************************************************************
|
|
D*--------------------------------------------------------
|
|
D* Declare variables used by CCA SAPI calls
|
|
D*--------------------------------------------------------
|
|
D* ** Return code
|
|
DRETURNCODE S 9B 0
|
|
D* ** Reason code
|
|
DREASONCODE S 9B 0
|
|
D* ** Exit data length
|
|
DEXITDATALEN S 9B 0
|
|
D* ** Exit data
|
|
DEXITDATA S 4
|
|
D* ** Rule array count
|
|
DRULEARRAYCNT S 9B 0
|
|
D* ** Rule array
|
|
DRULEARRAY S 16
|
|
D* ** Token length
|
|
DTOKENLEN S 9B 0 INZ(2500)
|
|
D* ** Token and array for subscripting
|
|
DTOKEN DS 2500
|
|
DTOKENARRAY 1 DIM(2500)
|
|
D* ** Private key name
|
|
DPRVNAME S 64
|
|
D* ** Certifying key name
|
|
DCERTKEY S 64
|
|
D*
|
|
DLSTRUCT DS
|
|
D* ** Clone KEK length - one is binary form and the
|
|
D* ** other is used for reading the value from a file
|
|
DCLONEKEKL 9B 0 INZ(500)
|
|
DCLONEKEKLC 1 4
|
|
D* ** Clone info length - one is binary form and the
|
|
D* ** other is used for reading the value from a file
|
|
DCLONEINFOLEN 9B 0 INZ(400)
|
|
DCLONEINFOLENC 5 8
|
|
D* ** Cloning key-encrypting-key
|
|
DCLONEKEK S 500
|
|
D* ** Cloning info
|
|
DCLONEINFO S 400
|
|
D* ** Share index
|
|
DSHAREIDX S 9B 0
|
|
D* ** Data structure for aligning 2 bytes into
|
|
D* ** a 2 bytes integer
|
|
DLENSTRUCT DS 2
|
|
DMSB 1 1
|
|
DLSB 2 2
|
|
DLENGTH 1 2B 0
|
|
D* ** Certificate section length
|
|
DCRTSECLEN S 9B 0
|
|
D* ** Public key section length
|
|
DPUBSECLEN S 9B 0
|
|
D* ** Index into Token array
|
|
DTKNINDEX S 9B 0
|
|
D* ** Number of bytes to read from a file
|
|
DINLEN S 9B 0
|
|
D* ** File descriptor
|
|
DFILED S 9B 0
|
|
D* ** File path and length
|
|
DPSTRUCT DS
|
|
DPATH 80 INZ(*ALLX'00')
|
|
DSIDX 11 12B 0
|
|
DPATHLEN S 9B 0
|
|
D* ** Open Flag - Open for Read only
|
|
DOFLAGR S 10I 0 INZ(1)
|
|
D* ** Base name of file to store cloning share
|
|
DSHAREFILE S 12 INZ('cloneShare00')
|
|
D*
|
|
D**********************************************************
|
|
D* Prototype for Master_Key_Distribution (CSUAMKD)
|
|
D**********************************************************
|
|
DCSUAMKD PR
|
|
DRETCOD 9B 0
|
|
DRSNCOD 9B 0
|
|
DEXTDTALN 9B 0
|
|
DEXTDT 4
|
|
DRARRYCT 9B 0
|
|
DRARRY 16
|
|
DSHRINDX 9B 0
|
|
DKYNAM 64
|
|
DCRTKYNAM 64
|
|
DCRTL 9B 0
|
|
DCRT 2500 OPTIONS(*VARSIZE)
|
|
DCLNKEKL 9B 0
|
|
DCLNKEK 1200 OPTIONS(*VARSIZE)
|
|
DCLNL 9B 0
|
|
DCLN 400 OPTIONS(*VARSIZE)
|
|
D*
|
|
D**********************************************************
|
|
D* Prototype for open()
|
|
D**********************************************************
|
|
D* value returned = file descriptor (OK), -1 (error)
|
|
Dopen PR 9B 0 EXTPROC('open')
|
|
D* path name of file to be opened.
|
|
D 128 OPTIONS(*VARSIZE)
|
|
D* Open flags
|
|
D 9B 0 VALUE
|
|
D* (OPTIONAL) mode - access rights
|
|
D 10U 0 VALUE OPTIONS(*NOPASS)
|
|
D* (OPTIONAL) codepage
|
|
D 10U 0 VALUE OPTIONS(*NOPASS)
|
|
D*
|
|
D*********************************************************************
|
|
D* Prototype for read()
|
|
D**********************************************************
|
|
D* value returned = number of bytes actually read, or -1
|
|
Dread PR 9B 0 EXTPROC('read')
|
|
D* File descriptor returned from open()
|
|
D 9B 0 VALUE
|
|
D* Input buffer
|
|
D 2500 OPTIONS(*VARSIZE)
|
|
D* Length of data to be read
|
|
D 9B 0 VALUE
|
|
D*
|
|
D*********************************************************************
|
|
D* Prototype for close()
|
|
D*********************************************************************
|
|
D* value returned = 0 (OK), or -1
|
|
Dclose PR 9B 0 EXTPROC('close')
|
|
D* File descriptor returned from open()
|
|
D 9B 0 VALUE
|
|
D*
|
|
D*-------------------------------------------------------------
|
|
D* ** Declares for sending messages to the
|
|
D* ** job log using the QMHSNDPM API
|
|
D*-------------------------------------------------------------
|
|
DMSG S 75 DIM(7) CTDATA PERRCD(1)
|
|
D DS
|
|
DMSGTEXT 1 80
|
|
DSAPI 1 7
|
|
DFAILRETC 41 44
|
|
DFAILRSNC 46 49
|
|
DMSGLENGTH S 9B 0 INZ(80)
|
|
DMESSAGEID S 7 INZ(' ')
|
|
DMESSAGEFILE S 21 INZ(' ')
|
|
DMSGKEY S 4 INZ(' ')
|
|
DMSGTYPE S 10 INZ('*INFO ')
|
|
DSTACKENTRY S 10 INZ('* ')
|
|
DSTACKCOUNTER S 9B 0 INZ(2)
|
|
DERRCODE DS
|
|
DBYTESIN 1 4B 0 INZ(0)
|
|
DBYTESOUT 5 8B 0 INZ(0)
|
|
C*
|
|
C**************************************************************
|
|
C* START OF PROGRAM *
|
|
C* *
|
|
C *ENTRY PLIST
|
|
C PARM SINDEX 15 5
|
|
C PARM PRVKEY 32
|
|
C PARM SAKEY 32
|
|
C PARM FILEPARM 32
|
|
C**************************************************************
|
|
C* Open certificate file
|
|
C**************************************************************
|
|
C* *---------------------*
|
|
C* ** Build path name *
|
|
C* *---------------------*
|
|
C EVAL PATHLEN = %LEN(%TRIM(FILEPARM))
|
|
C PATHLEN SUBST FILEPARM:1 PATH
|
|
C* *---------------------*
|
|
C* * Open the file *
|
|
C* *---------------------*
|
|
C EVAL FILED = open(PATH: OFLAGR)
|
|
C* *----------------------*
|
|
C* * Check if open worked *
|
|
C* *----------------------*
|
|
C FILED IFEQ -1
|
|
C* *------------------------------------*
|
|
C* * Open failed, send an error message *
|
|
C* *------------------------------------*
|
|
C MOVEL MSG(1) MSGTEXT
|
|
C EXSR SNDMSG
|
|
C RETURN
|
|
C*
|
|
C ENDIF
|
|
C* *--------------------------------------------------------*
|
|
C* * Open worked, read certificate from file and close file *
|
|
C* *--------------------------------------------------------*
|
|
C EVAL TOKENLEN = read(FILED: TOKEN: TOKENLEN)
|
|
C CALLP close (FILED)
|
|
C*
|
|
C* *--------------------------------------*
|
|
C* * Check if read operation was OK *
|
|
C* *--------------------------------------*
|
|
C TOKENLEN IFEQ -1
|
|
C MOVEL MSG(2) MSGTEXT
|
|
C EXSR SNDMSG
|
|
C ENDIF
|
|
C*
|
|
C* *--------------------------------------*
|
|
C* * Check if certificate length is valid *
|
|
C* * The length bytes start at position 3 *
|
|
C* *--------------------------------------*
|
|
C EVAL MSB = TOKENARRAY(3)
|
|
C EVAL LSB = TOKENARRAY(4)
|
|
C LENGTH IFLT TOKENLEN
|
|
C* *-----------------------------------*
|
|
C* * Certificate length is not valid *
|
|
C* *-----------------------------------*
|
|
C MOVEL MSG(3) MSGTEXT
|
|
C EXSR SNDMSG
|
|
C RETURN
|
|
C ENDIF
|
|
C*
|
|
C**************************************************************
|
|
C* Find the certificate in the token
|
|
C*
|
|
C* The layout of the token is
|
|
C*
|
|
C* - Token header - 8 bytes - including 2 length bytes
|
|
C* - Public key section - length bytes at position 2 (11 overall)
|
|
C* - Private key name - 68 bytes
|
|
C* - Certificate section
|
|
C*
|
|
C* Note: 1 is added because RPG arrays start at 1.
|
|
C**************************************************************
|
|
C EVAL MSB = TOKENARRAY(11)
|
|
C EVAL LSB = TOKENARRAY(12)
|
|
C EVAL PUBSECLEN = LENGTH
|
|
C EVAL TKNINDEX = PUBSECLEN + 68 + 8 + 1
|
|
C*
|
|
C* *-----------------------------------------*
|
|
C* * Determine length of certificate section *
|
|
C* * Length bytes are at position 2 of the *
|
|
C* * section.
|
|
C* *-----------------------------------------*
|
|
C EVAL MSB = TOKENARRAY(TKNINDEX + 2)
|
|
C EVAL LSB = TOKENARRAY(TKNINDEX + 3)
|
|
C EVAL CRTSECLEN = LENGTH
|
|
C*
|
|
C**********************************************************
|
|
C* Open and read the clone file
|
|
C**********************************************************
|
|
C* *------------------------------------------*
|
|
C* * Set share index number *
|
|
C* * (Convert from packed 15 5 to binary) *
|
|
C* *------------------------------------------*
|
|
C Z-ADD SINDEX SHAREIDX
|
|
C* ** Build path name
|
|
C MOVEL *ALLX'00' PATH
|
|
C MOVEL SHAREFILE PATH
|
|
C* ** Adjust two digits on file name by adding to their
|
|
C* ** character value
|
|
C SIDX ADD SHAREIDX SIDX
|
|
C* ** If the index is greater than or equal to 10
|
|
C* ** then add 246 to force the first character to change
|
|
C SHAREIDX IFGE 10
|
|
C SIDX ADD 246 SIDX
|
|
C ENDIF
|
|
C*
|
|
C* ** Open the file
|
|
C*
|
|
C EVAL FILED = open(PATH: OFLAGR)
|
|
C*
|
|
C* ** Check if open worked
|
|
C*
|
|
C FILED IFEQ -1
|
|
C*
|
|
C* ** Open failed, send an error message
|
|
C*
|
|
C MOVEL MSG(4) MSGTEXT
|
|
C EXSR SNDMSG
|
|
C*
|
|
C ELSE
|
|
C*
|
|
C* ** Open worked, read in the clone information and close file
|
|
C*
|
|
C SETON 01
|
|
C Z-ADD 4 INLEN
|
|
C EVAL INLEN = read(FILED: CLONEKEKLC: INLEN)
|
|
C*
|
|
C* *--------------------------------------*
|
|
C* * Check if read operation was OK *
|
|
C* *--------------------------------------*
|
|
C INLEN IFNE 4
|
|
C MOVEL MSG(5) MSGTEXT
|
|
C EXSR SNDMSG
|
|
C SETOFF 01
|
|
C ENDIF
|
|
C*
|
|
C 01 EVAL INLEN = read(FILED: CLONEKEK: CLONEKEKL)
|
|
C*
|
|
C 01INLEN IFNE CLONEKEKL
|
|
C MOVEL MSG(5) MSGTEXT
|
|
C EXSR SNDMSG
|
|
C SETOFF 01
|
|
C ENDIF
|
|
C*
|
|
C 01 Z-ADD 4 INLEN
|
|
C 01 EVAL INLEN = read(FILED: CLONEINFOLENC: INLEN)
|
|
C*
|
|
C* *--------------------------------------*
|
|
C* * Check if read operation was OK *
|
|
C* *--------------------------------------*
|
|
C 01INLEN IFNE 4
|
|
C MOVEL MSG(5) MSGTEXT
|
|
C EXSR SNDMSG
|
|
C SETOFF 01
|
|
C ENDIF
|
|
C*
|
|
C 01 EVAL INLEN = read(FILED: CLONEINFO: CLONEINFOLEN)
|
|
C*
|
|
C* *--------------------------------------*
|
|
C* * Check if read operation was OK *
|
|
C* *--------------------------------------*
|
|
C 01INLEN IFNE CLONEINFOLEN
|
|
C MOVEL MSG(5) MSGTEXT
|
|
C EXSR SNDMSG
|
|
C SETOFF 01
|
|
C ENDIF
|
|
C*
|
|
C CALLP close (FILED)
|
|
C N01 SETON LR
|
|
C*
|
|
C**************************************************************
|
|
C* Obtain a certificate
|
|
C**************************************************************
|
|
C* *------------------------------------------*
|
|
C* * Set share index number *
|
|
C* *------------------------------------------*
|
|
C Z-ADD SINDEX SHAREIDX
|
|
C* *------------------------------------------*
|
|
C* * Set private key name *
|
|
C* *------------------------------------------*
|
|
C EVAL LENGTH = %LEN(%TRIM(PRVKEY))
|
|
C LENGTH SUBST PRVKEY:1 PRVNAME
|
|
C* *------------------------------------------*
|
|
C* * Set certifying key name *
|
|
C* *------------------------------------------*
|
|
C EVAL LENGTH = %LEN(%TRIM(SAKEY))
|
|
C LENGTH SUBST SAKEY:1 CERTKEY
|
|
C* *------------------------------------------*
|
|
C* * Set the keywords in the rule array *
|
|
C* *------------------------------------------*
|
|
C MOVEL 'INSTALL ' RULEARRAY
|
|
C Z-ADD 1 RULEARRAYCNT
|
|
C* *------------------------------------*
|
|
C* * Call Master Key Distribution SAPI *
|
|
C* *------------------------------------*
|
|
C CALLP CSUAMKD (RETURNCODE:
|
|
C REASONCODE:
|
|
C EXITDATALEN:
|
|
C EXITDATA:
|
|
C RULEARRAYCNT:
|
|
C RULEARRAY:
|
|
C SHAREIDX:
|
|
C PRVNAME:
|
|
C CERTKEY:
|
|
C CRTSECLEN:
|
|
C TOKENARRAY(TKNINDEX):
|
|
C CLONEKEKL:
|
|
C CLONEKEK:
|
|
C CLONEINFOLEN:
|
|
C CLONEINFO)
|
|
C* *------------------------*
|
|
C* * Check the return code *
|
|
C* *------------------------*
|
|
C RETURNCODE IFGT 4
|
|
C* *-----------------------*
|
|
C* * Send failure message *
|
|
C* *-----------------------*
|
|
C MOVEL MSG(6) MSGTEXT
|
|
C MOVE RETURNCODE FAILRETC
|
|
C MOVE REASONCODE FAILRSNC
|
|
C MOVEL 'CSUAMKD' SAPI
|
|
C EXSR SNDMSG
|
|
C RETURN
|
|
C ENDIF
|
|
C* *-----------------------*
|
|
C* * Send success message *
|
|
C* *-----------------------*
|
|
C MOVEL MSG(7) MSGTEXT
|
|
C EVAL %SUBST(MSGTEXT: 32: 12) =
|
|
C %SUBST(PATH: 1: 12)
|
|
C EXSR SNDMSG
|
|
C ENDIF
|
|
C*
|
|
C SETON LR
|
|
C*
|
|
C**************************************************************
|
|
C* Subroutine to send a message
|
|
C**************************************************************
|
|
C SNDMSG BEGSR
|
|
C CALL 'QMHSNDPM'
|
|
C PARM MESSAGEID
|
|
C PARM MESSAGEFILE
|
|
C PARM MSGTEXT
|
|
C PARM MSGLENGTH
|
|
C PARM MSGTYPE
|
|
C PARM STACKENTRY
|
|
C PARM STACKCOUNTER
|
|
C PARM MSGKEY
|
|
C PARM ERRCODE
|
|
C ENDSR
|
|
C*
|
|
**
|
|
The certificate file could not be opened.
|
|
There was an error reading from the certificate file.
|
|
The length of the certificate is not valid.
|
|
The clone share file could not be opened.
|
|
The clone share file either could not be read or has invalid data.
|
|
CSUAMKD failed with return/reason codes 9999/9999.
|
|
The share was successfully installed.</pre>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzajcworking.htm" title="After you set up your Cryptographic Coprocessor, you can begin writing programs to make use of your Cryptographic Coprocessor's cryptographic functions.">Manage the Cryptographic Coprocessor</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |