packages/OS400/README.OS400

   1
   2 Implementation notes:
   3
   4   This is a true OS/400 implementation, not a PASE implementation (for PASE,
   5 use AIX implementation).
   6
   7   The biggest problem with OS/400 is EBCDIC. Libcurl implements an internal
   8 conversion mechanism, but it has been designed for computers that have a
   9 single native character set. OS/400 default native character set varies
  10 depending on the country for which it has been localized. And more, a job
  11 may dynamically alter its "native" character set.
  12   Several characters that do not have fixed code in EBCDIC variants are
  13 used in libcurl strings. As a consequence, using the existing conversion
  14 mechanism would have lead in a localized binary library - not portable across
  15 countries.
  16   For this reason, and because libcurl was originally designed for ASCII based
  17 operating systems, the current OS/400 implementation uses ASCII as internal
  18 character set. This has been accomplished using the QADRT library and
  19 include files, a C and system procedures ASCII wrapper library. See IBM QADRT
  20 description for more information.
  21   This then results in libcurl being an ASCII library: any function string
  22 argument is taken/returned in ASCII and a C/C++ calling program built around
  23 QADRT may use libcurl functions as on any other platform.
  24   QADRT does not define ASCII wrappers for all C/system procedures: the
  25 OS/400 configuration header file and an additional module (os400sys.c) define
  26 some more of them, that are used by libcurl and that QADRT left out.
  27   To support all the different variants of EBCDIC, non-standard wrapper
  28 procedures have been added to libcurl on OS/400: they provide an additional
  29 CCSID (numeric Coded Character Set ID specific to OS/400) parameter for each
  30 string argument. String values passed to callback procedures are NOT converted,
  31 so text gathered this way is (probably !) ASCII.
  32
  33   Another OS/400 problem comes from the fact that the last fixed argument of a
  34 vararg procedure may not be of type char, unsigned char, short or unsigned
  35 short. Enums that are internally implemented by the C compiler as one of these
  36 types are also forbidden. Libcurl uses enums as vararg procedure tagfields...
  37 Happily, there is a pragma forcing enums to type "int". The original libcurl
  38 header files are thus altered during build process to use this pragma, in
  39 order to force libcurl enums of being type int (the pragma disposition in use
  40 before inclusion is restored before resuming the including unit compilation).
  41
  42   Secure socket layer is provided by the IBM GSKit API: unlike other SSL
  43 implementations, GSKit is based on "certificate stores" or keyrings
  44 rather than individual certificate/key files. Certificate stores, as well as
  45 "certificate labels" are managed by external IBM-defined applications.
  46   There are two ways to specify an SSL context:
  47 - By an application identifier.
  48 - By a keyring file pathname and (optionally) certificate label.
  49   To identify an SSL context by application identifier, use option
  50 SETOPT_SSLCERT to specify the application identifier.
  51   To address an SSL context by keyring and certificate label, use CURLOPT_CAINFO
  52 to set-up the keyring pathname, CURLOPT_SSLCERT to define the certificate label
  53 (omitting it will cause the default certificate in keyring to be used) and
  54 CURLOPT_KEYPASSWD to give the keyring password. If SSL is used without
  55 defining any of these options, the default (i.e.: system) keyring is used for
  56 server certificate validation.
  57
  58   Non-standard EBCDIC wrapper prototypes are defined in an additional header
  59 file: ccsidcurl.h. These should be self-explanatory to an OS/400-aware
  60 designer. CCSID 0 can be used to select the current job's CCSID.
  61   Wrapper procedures with variable arguments are described below:
  62
  63 _ curl_easy_setopt_ccsid()
  64   Variable arguments are a string pointer and a CCSID (unsigned int) for
  65 options:
  66         CURLOPT_CAINFO
  67         CURLOPT_CAPATH
  68         CURLOPT_COOKIE
  69         CURLOPT_COOKIEFILE
  70         CURLOPT_COOKIEJAR
  71         CURLOPT_COOKIELIST
  72         CURLOPT_COPYPOSTFIELDS
  73         CURLOPT_CRLFILE
  74         CURLOPT_CUSTOMREQUEST
  75         CURLOPT_DNS_SERVERS
  76         CURLOPT_EGDSOCKET
  77         CURLOPT_ENCODING
  78         CURLOPT_FTP_ACCOUNT
  79         CURLOPT_FTP_ALTERNATIVE_TO_USER
  80         CURLOPT_FTPPORT
  81         CURLOPT_INTERFACE
  82         CURLOPT_ISSUERCERT
  83         CURLOPT_KEYPASSWD
  84         CURLOPT_KRBLEVEL
  85         CURLOPT_LOGIN_OPTIONS
  86         CURLOPT_MAIL_FROM
  87         CURLOPT_MAIL_AUTH
  88         CURLOPT_NETRC_FILE
  89         CURLOPT_NOPROXY
  90         CURLOPT_PASSWORD
  91         CURLOPT_PINNEDPUBLICKEY
  92         CURLOPT_PROXY
  93         CURLOPT_PROXYPASSWORD
  94         CURLOPT_PROXYUSERNAME
  95         CURLOPT_PROXYUSERPWD
  96         CURLOPT_RANDOM_FILE
  97         CURLOPT_RANGE
  98         CURLOPT_REFERER
  99         CURLOPT_RTSP_SESSION_UID
 100         CURLOPT_RTSP_STREAM_URI
 101         CURLOPT_RTSP_TRANSPORT
 102         CURLOPT_SOCKS5_GSSAPI_SERVICE
 103         CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 Note: SSH not available on OS400.
 104         CURLOPT_SSH_KNOWNHOSTS          Note: SSH not available on OS400.
 105         CURLOPT_SSH_PRIVATE_KEYFILE     Note: SSH not available on OS400.
 106         CURLOPT_SSH_PUBLIC_KEYFILE      Note: SSH not available on OS400.
 107         CURLOPT_SSLCERT
 108         CURLOPT_SSLCERTTYPE
 109         CURLOPT_SSL_CIPHER_LIST
 110         CURLOPT_SSLENGINE
 111         CURLOPT_SSLKEY
 112         CURLOPT_SSLKEYTYPE
 113         CURLOPT_TLSAUTH_PASSWORD
 114         CURLOPT_TLSAUTH_TYPE
 115         CURLOPT_TLSAUTH_USERNAME
 116         CURLOPT_UNIX_SOCKET_PATH
 117         CURLOPT_URL
 118         CURLOPT_USERAGENT
 119         CURLOPT_USERNAME
 120         CURLOPT_USERPWD
 121         CURLOPT_XOAUTH2_BEARER
 122   Else it is the same as for curl_easy_setopt().
 123   Note that CURLOPT_ERRORBUFFER is not in the list above, since it gives the
 124 address of an (empty) character buffer, not the address of a string.
 125 CURLOPT_POSTFIELDS stores the address of static binary data (of type void *) and
 126 thus is not converted. If CURLOPT_COPYPOSTFIELDS is issued after
 127 CURLOPT_POSTFIELDSIZE != -1, the data size is adjusted according to the
 128 CCSID conversion result length.
 129
 130 _ curl_formadd_ccsid()
 131   In the variable argument list, string pointers should be followed by a (long)
 132 CCSID for the following options:
 133         CURLFORM_FILENAME
 134         CURLFORM_CONTENTTYPE
 135         CURLFORM_BUFFER
 136         CURLFORM_FILE
 137         CURLFORM_FILECONTENT
 138         CURLFORM_COPYCONTENTS
 139         CURLFORM_COPYNAME
 140         CURLFORM_PTRNAME
 141   If taken from an argument array, an additional array entry must follow each
 142 entry containing one of the above option. This additional entry holds the CCSID
 143 in its value field, and the option field is meaningless.
 144   It is not possible to have a string pointer and its CCSID across a function
 145 parameter/array boundary.
 146   Please note that CURLFORM_PTRCONTENTS and CURLFORM_BUFFERPTR are considered
 147 unconvertible strings and thus are NOT followed by a CCSID.
 148
 149 _ curl_easy_getinfo_ccsid
 150   The following options are followed by a 'char * *' and a CCSID. Unlike
 151 curl_easy_getinfo(), the value returned in the pointer should be freed after
 152 use:
 153         CURLINFO_EFFECTIVE_URL
 154         CURLINFO_CONTENT_TYPE
 155         CURLINFO_FTP_ENTRY_PATH
 156         CURLINFO_REDIRECT_URL
 157         CURLINFO_PRIMARY_IP
 158         CURLINFO_RTSP_SESSION_ID
 159         CURLINFO_LOCAL_IP
 160   Likewise, the following options are followed by a struct curl_slist * * and a
 161 CCSID.
 162         CURLINFO_SSL_ENGINES
 163         CURLINFO_COOKIELIST
 164 Lists returned should be released with curl_slist_free_all() after use.
 165   Option CURLINFO_CERTINFO is followed by a struct curl_certinfo * * and a
 166 CCSID. Returned structures sould be free'ed using curl_certinfo_free_all() after
 167 use.
 168   Other options are processed like in curl_easy_getinfo().
 169
 170   Standard compilation environment does support neither autotools nor make;
 171 in fact, very few common utilities are available. As a consequence, the
 172 config-os400.h has been coded manually and the compilation scripts are
 173 a set of shell scripts stored in subdirectory packages/OS400.
 174
 175   The "curl" command and the test environment are currently not supported on
 176 OS/400.
 177
 178
 179 Protocols currently implemented on OS/400:
 180 _ DICT
 181 _ FILE
 182 _ FTP
 183 _ FTPS
 184 _ FTP with secure transmission
 185 _ GOPHER
 186 _ HTTP
 187 _ HTTPS
 188 _ IMAP
 189 _ IMAPS
 190 _ IMAP with secure transmission
 191 _ LDAP
 192 _ POP3
 193 _ POP3S
 194 _ POP3 with secure transmission
 195 _ RTSP
 196 _ SMTP
 197 _ SMTPS
 198 _ SMTP with secure transmission
 199 _ TELNET
 200 _ TFTP
 201
 202
 203
 204 Compiling on OS/400:
 205
 206   These instructions targets people who knows about OS/400, compiling, IFS and
 207 archive extraction. Do not ask questions about these subjects if you're not
 208 familiar with.
 209
 210 _ As a prerequisite, QADRT development environment must be installed.
 211 _ Install the curl source directory in IFS.
 212 _ Enter shell (QSH)
 213 _ Change current directory to the curl installation directory
 214 _ Change current directory to ./packages/OS400
 215 _ Edit file iniscript.sh. You may want to change tunable configuration
 216   parameters, like debug info generation, optimisation level, listing option,
 217   target library, etc.
 218 _ Copy any file in the current directory to makelog (i.e.:
 219   cp initscript.sh makelog): this is intended to create the makelog file with
 220   an ASCII CCSID!
 221 _ Enter the command "sh makefile.sh > makelog 2>&1'
 222 _ Examine the makelog file to check for compilation errors.
 223
 224   Leaving file initscript.sh unchanged, this will produce the following OS/400
 225 objects:
 226 _ Library CURL. All other objects will be stored in this library.
 227 _ Modules for all libcurl units.
 228 _ Binding directory CURL_A, to be used at calling program link time for
 229   statically binding the modules (specify BNDSRVPGM(QADRTTS QGLDCLNT QGLDBRDR)
 230   when creating a program using CURL_A).
 231 _ Service program CURL.<soname>, where <soname> is extracted from the
 232   lib/Makefile.am VERSION variable. To be used at calling program run-time
 233   when this program has dynamically bound curl at link time.
 234 _ Binding directory CURL. To be used to dynamically bind libcurl when linking a
 235   calling program.
 236 _ Source file H. It contains all the include members needed to compile a C/C++
 237   module using libcurl, and an ILE/RPG /copy member for support in this
 238   language.
 239 _ Standard C/C++ libcurl include members in file H.
 240 _ CCSIDCURL member in file H. This defines the non-standard EBCDIC wrappers for
 241   C and C++.
 242 _ CURL.INC member in file H. This defines everything needed by an ILE/RPG
 243   program using libcurl.
 244 _ LIBxxx modules and programs. Although the test environment is not supported
 245   on OS/400, the libcurl test programs are compiled for manual tests.
 246
 247
 248
 249 Special programming consideration:
 250
 251 QADRT being used, the following points must be considered:
 252 _ If static binding is used, service program QADRTTS must be linked too.
 253 _ The EBCDIC CCSID used by QADRT is 37 by default, NOT THE JOB'S CCSID. If
 254   another EBCDIC CCSID is required, it must be set via a locale through a call
 255   to setlocale_a (QADRT's setlocale() ASCII wrapper) with category LC_ALL or
 256   LC_CTYPE, or by setting environment variable QADRT_ENV_LOCALE to the locale
 257   object path before executing the program.
 258 _ Do not use original source include files unless you know what you are doing.
 259   Use the installed members instead (in /QSYS.LIB/CURL.LIB/H.FILE).
 260
 261
 262
 263 ILE/RPG support:
 264
 265   Since 95% of the OS/400 programmers use ILE/RPG exclusively, a definition
 266   /COPY member is provided for this language. To include all libcurl
 267   definitions in an ILE/RPG module, line
 268
 269      h bnddir('CURL/CURL')
 270
 271 must figure in the program header, and line
 272
 273      d/copy curl/h,curl.inc
 274
 275 in the global data section of the module's source code.
 276
 277   No vararg procedure support exists in ILE/RPG: for this reason, the following
 278 considerations apply:
 279 _ Procedures curl_easy_setopt_long(), curl_easy_setopt_object(),
 280   curl_easy_setopt_function() and curl_easy_setopt_offset() are all alias
 281   prototypes to curl_easy_setopt(), but with different parameter lists.
 282 _ Procedures curl_easy_getinfo_string(), curl_easy_getinfo_long(),
 283   curl_easy_getinfo_double() and curl_easy_getinfo_slist() are all alias
 284   prototypes to curl_easy_getinfo(), but with different parameter lists.
 285 _ Procedures curl_multi_setopt_long(), curl_multi_setopt_object(),
 286   curl_multi_setopt_function() and curl_multi_setopt_offset() are all alias
 287   prototypes to curl_multi_setopt(), but with different parameter lists.
 288 _ The prototype of procedure curl_formadd() allows specifying a pointer option
 289   and the CURLFORM_END option. This makes possible to use an option array
 290   without any additional definition. If some specific incompatible argument
 291   list is used in the ILE/RPG program, the latter must define a specialised
 292   alias. The same applies to curl_formadd_ccsid() too.
 293
 294   Since RPG cannot cast a long to a pointer, procedure curl_form_long_value()
 295 is provided for that purpose: this allows storing a long value in the curl_forms
 296 array.