/*********************************************************************/ /* Licensed Materials - Property of IBM */ /* "Restricted Materials of IBM" */ /* 5748-T15 */ /* Copyright IBM Corp. 2010 */ /* All Rights Reserved */ /* US Government Users Restricted Rights - Use, duplication */ /* or disclosure restricted by GSA ADP Schedule Contract */ /* with IBM Corp. */ /*********************************************************************/ /* This driver is provided on an "as is" basis. There are no */ /* warranties, express or implied, including the implied warranties */ /* of merchantability and fitness for a particular purpose. */ /* IBM has no obligation to provide service, defect correction, or */ /* any maintenance for the driver. IBM has no obligation to supply */ /* any updates or enhancements for the driver to you even if such are*/ /* or later become available. */ /*********************************************************************/ SOCK sample driver README CONTENTS ________ This file includes the following information: 1.0 PREREQUISITES 2.0 INSTALLATION 3.0 CUSTOMIZATION 4.0 RUNNING THE DRIVER 5.0 NOTICES 5.1 Trademarks 1.0 PREREQUISITES __________________ The release levels are the following: maketpf/bldtpf tool for z/TPF 1.1 2.0 INSTALLATION _________________ 1) FTP the tar file (sock.tar.gz) to your linux system. This can be placed in any directory as a holding location, for example: /tmp/ztpftar 2) Create a root directory that will hold the unpacked files, for example: /ztpfdrvs 3) Extract the source code from the tar file by entering the following commands: cd /ztpfdrvs tar -xvzf /tmp/ztpftar/sock.tar.gz The driver source files will be extracted in the following directory structure: sock/a2e.h sock/iptethd_sock.h sock/qssc.c sock/qssc.mak sock/qssd.c sock/qssd.mak sock/qssl.c sock/qssl.mak sock/qssm.c sock/qssn.c sock/qssn.mak sock/qsso.c sock/qsso.mak sock/qssp.c sock/qssp.mak sock/qssq.c sock/qssq.mak sock/qssr.c sock/qssr.mak sock/qsss.c sock/qsss.mak sock/qsst.c sock/qxy7.c sock/qxy7.mak sock/qxy8.c sock/qxy9.c sock/qxya.c sock/qxya.mak sock/qxyb.c sock/qxyc.c sock/qxyd.c sock/qxye.c sock/qxyf.c sock/qxyg.c sock/qxyh.c sock/qxyi.c sock/qxyj.c sock/qxyk.c sock/qxyk.mak sock/qxyl.c sock/qxyl.mak sock/qxym.c sock/qxym.mak sock/qxyn.c sock/qxyn.mak sock/qxyo.c sock/qxyo.mak sock/qxyp.c sock/qxyp.mak sock/qxyq.c sock/qxyr.c sock/qxys.c sock/qxyt.c sock/qxyu.c sock/qxyv.c sock/qxyw.c sock/qxyx.c sock/qxyy.c sock/qxyz.c sock/qxz3.c sock/qxz3.mak sock/qxz4.c sock/qxz4.mak sock/qxz8.c sock/qxz8.mak sock/qxza.c sock/qxzb.c sock/qxzc.c sock/qxzd.c sock/qxze.c sock/qxzf.c sock/qxzg.c sock/qxzi.c sock/qxzj.c sock/qxzo.c sock/qxzo.mak sock/qxzr.c sock/qxzr.mak sock/qxzs.c sock/qxzs.mak sock/qxzt.c sock/qxzt.mak sock/qxzu.c sock/qxzu.mak sock/qxzv.c sock/qxzv.mak sock/qxzw.c sock/qxzw.mak sock/qxzx.c sock/qxzx.mak sock/sock.cntl sock/sockclient.c sock/soclclient.mak 4) Create a maketpf.cfg file with the following contents: APPL_ROOT := /ztpfdrvs TPF_ROOT := /ztpf TPF_BSS_NAME := BSS #TPF_SS_NAME := WP #USER_VERSION_CODE := a) Set APPL_ROOT to the directory containing the driver source code extracted. b) Set TPF_ROOT to the directory containing the z/TPF source code. c) Set TPF_BSS_NAME to the basic subsystem name of your TPF system. By default, this is set to BSS. d) Optionally, set the TPF_SS_NAME to the subsystem name. e) Optionally, set USER_VERSION_CODE to any desired two-character string for user version code for the shared objects built. By default, this is set to null. Refer to the maketpf tool documentation for details on these variables. 5) Build the USRSTUB program after adding the SOCK driver control file to your user control file. a) Add the following line to your user control file base/cntl/usr.cntl include sock/sock.cntl b) Build the USRSTUB program to generate stubs for the driver programs using the following command: maketpf USRSTUB -f 6) Run the maketpf tool with the accompanied control file (sock.cntl) to assemble, compile, and link the driver programs: bldtpf /ztpfdrvs/sock/sock.cntl 7) Use the standard load procedure to transfer and load the following driver programs to the TPF system: qssc.o qssd.o qssl.o qssn.o qsso.o qssp.o qssq.o qssr.o qsss.o qxy7.o qxya.o qxyk.o qxyl.o qxym.o qxyn.o qxyo.o qxyp.o qxz3.o qxz4.o qxz8.o qxzo.o qxzr.o qxzs.o qxzt.o qxzu.o qxzv.o qxzw.o qxzx.o soclclient.o See Program Management for more information about building and loading programs to the TPF system. 3.0 CUSTOMIZATION __________________ Update base/rt/cvzz.asm (or the tool that executes driver programs) to make an entry for this driver. The shared object QXYA is the main entry point for this driver. Build and load the updated CVZZ program to the TPF system. 4.0 RUNNING THE DRIVER _______________________ To properly set up the system for the SSL driver, the following procedures need to be performed on the TPF system. 1. Make sure MTHD value in CTKA is not zero. Use ZCTKA DISP THREAD to display the value. Use ZCTKA ALT MTHD-100 to alter the value and ZRIPL. 2. Make sure SSLPROC and SSLTHRD in CTK2 are not 0. ZNKEY SSLPROC & ZNKEY SSLTHRD. 3. Create a CERTS directory on the file system via zfile mkdir certs. 4 FTP the certificate to TPF file system under CERTS directory. Have all the certificate with 777 permission: ZFILE chmod 777 /CERTS/... Please read the user's guide, available in Portable Document Format (PDF), provided along with this driver for more information about running the driver. You can also issue ZTEST SOCK HELP for the online help display. 5.0 NOTICES ___________ IBM may not offer the products, services, or features discussed in this information in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this information. The furnishing of this information does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation Department 830A Mail Drop P131 2455 South Road Poughkeepsie, NY 12601-5400 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. 5.1 Trademarks _______________ The following terms are trademarks of the International Business Machines Corporation in the United States, or other countries, or both: IBM Other company, product, and service names may be trademarks or service marks of others. THIS DOCUMENT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IBM DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE AND MERCHANTABILITY WITH RESPECT TO THE INFORMATION IN THIS DOCUMENT. BY FURNISHING THIS DOCUMENT, IBM GRANTS NO LICENSES TO ANY PATENTS OR COPYRIGHTS. Copyright IBM Corporation 2010. All rights reserved.