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_PROXY_SERVICE_NAME
  97         CURLOPT_RANDOM_FILE
  98         CURLOPT_RANGE
  99         CURLOPT_REFERER
 100         CURLOPT_RTSP_SESSION_UID
 101         CURLOPT_RTSP_STREAM_URI
 102         CURLOPT_RTSP_TRANSPORT
 103         CURLOPT_SERVICE_NAME
 104         CURLOPT_SOCKS5_GSSAPI_SERVICE
 105         CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 Note: SSH not available on OS400.
 106         CURLOPT_SSH_KNOWNHOSTS          Note: SSH not available on OS400.
 107         CURLOPT_SSH_PRIVATE_KEYFILE     Note: SSH not available on OS400.
 108         CURLOPT_SSH_PUBLIC_KEYFILE      Note: SSH not available on OS400.
 109         CURLOPT_SSLCERT
 110         CURLOPT_SSLCERTTYPE
 111         CURLOPT_SSL_CIPHER_LIST
 112         CURLOPT_SSLENGINE
 113         CURLOPT_SSLKEY
 114         CURLOPT_SSLKEYTYPE
 115         CURLOPT_TLSAUTH_PASSWORD
 116         CURLOPT_TLSAUTH_TYPE
 117         CURLOPT_TLSAUTH_USERNAME
 118         CURLOPT_UNIX_SOCKET_PATH
 119         CURLOPT_URL
 120         CURLOPT_USERAGENT
 121         CURLOPT_USERNAME
 122         CURLOPT_USERPWD
 123         CURLOPT_XOAUTH2_BEARER
 124   Else it is the same as for curl_easy_setopt().
 125   Note that CURLOPT_ERRORBUFFER is not in the list above, since it gives the
 126 address of an (empty) character buffer, not the address of a string.
 127 CURLOPT_POSTFIELDS stores the address of static binary data (of type void *) and
 128 thus is not converted. If CURLOPT_COPYPOSTFIELDS is issued after
 129 CURLOPT_POSTFIELDSIZE != -1, the data size is adjusted according to the
 130 CCSID conversion result length.
 131
 132 _ curl_formadd_ccsid()
 133   In the variable argument list, string pointers should be followed by a (long)
 134 CCSID for the following options:
 135         CURLFORM_FILENAME
 136         CURLFORM_CONTENTTYPE
 137         CURLFORM_BUFFER
 138         CURLFORM_FILE
 139         CURLFORM_FILECONTENT
 140         CURLFORM_COPYCONTENTS
 141         CURLFORM_COPYNAME
 142         CURLFORM_PTRNAME
 143   If taken from an argument array, an additional array entry must follow each
 144 entry containing one of the above option. This additional entry holds the CCSID
 145 in its value field, and the option field is meaningless.
 146   It is not possible to have a string pointer and its CCSID across a function
 147 parameter/array boundary.
 148   Please note that CURLFORM_PTRCONTENTS and CURLFORM_BUFFERPTR are considered
 149 unconvertible strings and thus are NOT followed by a CCSID.
 150
 151 _ curl_easy_getinfo_ccsid()
 152   The following options are followed by a 'char * *' and a CCSID. Unlike
 153 curl_easy_getinfo(), the value returned in the pointer should be freed after
 154 use:
 155         CURLINFO_EFFECTIVE_URL
 156         CURLINFO_CONTENT_TYPE
 157         CURLINFO_FTP_ENTRY_PATH
 158         CURLINFO_REDIRECT_URL
 159         CURLINFO_PRIMARY_IP
 160         CURLINFO_RTSP_SESSION_ID
 161         CURLINFO_LOCAL_IP
 162   Likewise, the following options are followed by a struct curl_slist * * and a
 163 CCSID.
 164         CURLINFO_SSL_ENGINES
 165         CURLINFO_COOKIELIST
 166 Lists returned should be released with curl_slist_free_all() after use.
 167   Option CURLINFO_CERTINFO is followed by a struct curl_certinfo * * and a
 168 CCSID. Returned structures sould be free'ed using curl_certinfo_free_all() after
 169 use.
 170   Other options are processed like in curl_easy_getinfo().
 171
 172 _ curl_pushheader_bynum_cssid() and curl_pushheader_byname_ccsid()
 173   Although the prototypes are self-explanatory, the returned string pointer
 174 should be freed after use, as opposite to the non-ccsid versions of these
 175 procedures.
 176   Please note that HTTP2 is not (yet) implemented on OS/400, thus these
 177 functions will always return NULL.
 178
 179
 180   Standard compilation environment does support neither autotools nor make;
 181 in fact, very few common utilities are available. As a consequence, the
 182 config-os400.h has been coded manually and the compilation scripts are
 183 a set of shell scripts stored in subdirectory packages/OS400.
 184
 185   The "curl" command and the test environment are currently not supported on
 186 OS/400.
 187
 188
 189 Protocols currently implemented on OS/400:
 190 _ DICT
 191 _ FILE
 192 _ FTP
 193 _ FTPS
 194 _ FTP with secure transmission
 195 _ GOPHER
 196 _ HTTP
 197 _ HTTPS
 198 _ IMAP
 199 _ IMAPS
 200 _ IMAP with secure transmission
 201 _ LDAP
 202 _ POP3
 203 _ POP3S
 204 _ POP3 with secure transmission
 205 _ RTSP
 206 _ SMTP
 207 _ SMTPS
 208 _ SMTP with secure transmission
 209 _ TELNET
 210 _ TFTP
 211
 212
 213
 214 Compiling on OS/400:
 215
 216   These instructions targets people who knows about OS/400, compiling, IFS and
 217 archive extraction. Do not ask questions about these subjects if you're not
 218 familiar with.
 219
 220 _ As a prerequisite, QADRT development environment must be installed.
 221 _ Install the curl source directory in IFS.
 222 _ Enter shell (QSH)
 223 _ Change current directory to the curl installation directory
 224 _ Change current directory to ./packages/OS400
 225 _ Edit file iniscript.sh. You may want to change tunable configuration
 226   parameters, like debug info generation, optimisation level, listing option,
 227   target library, etc.
 228 _ Copy any file in the current directory to makelog (i.e.:
 229   cp initscript.sh makelog): this is intended to create the makelog file with
 230   an ASCII CCSID!
 231 _ Enter the command "sh makefile.sh > makelog 2>&1'
 232 _ Examine the makelog file to check for compilation errors.
 233
 234   Leaving file initscript.sh unchanged, this will produce the following OS/400
 235 objects:
 236 _ Library CURL. All other objects will be stored in this library.
 237 _ Modules for all libcurl units.
 238 _ Binding directory CURL_A, to be used at calling program link time for
 239   statically binding the modules (specify BNDSRVPGM(QADRTTS QGLDCLNT QGLDBRDR)
 240   when creating a program using CURL_A).
 241 _ Service program CURL.<soname>, where <soname> is extracted from the
 242   lib/Makefile.am VERSION variable. To be used at calling program run-time
 243   when this program has dynamically bound curl at link time.
 244 _ Binding directory CURL. To be used to dynamically bind libcurl when linking a
 245   calling program.
 246 _ Source file H. It contains all the include members needed to compile a C/C++
 247   module using libcurl, and an ILE/RPG /copy member for support in this
 248   language.
 249 _ Standard C/C++ libcurl include members in file H.
 250 _ CCSIDCURL member in file H. This defines the non-standard EBCDIC wrappers for
 251   C and C++.
 252 _ CURL.INC member in file H. This defines everything needed by an ILE/RPG
 253   program using libcurl.
 254 _ LIBxxx modules and programs. Although the test environment is not supported
 255   on OS/400, the libcurl test programs are compiled for manual tests.
 256
 257
 258
 259 Special programming consideration:
 260
 261 QADRT being used, the following points must be considered:
 262 _ If static binding is used, service program QADRTTS must be linked too.
 263 _ The EBCDIC CCSID used by QADRT is 37 by default, NOT THE JOB'S CCSID. If
 264   another EBCDIC CCSID is required, it must be set via a locale through a call
 265   to setlocale_a (QADRT's setlocale() ASCII wrapper) with category LC_ALL or
 266   LC_CTYPE, or by setting environment variable QADRT_ENV_LOCALE to the locale
 267   object path before executing the program.
 268 _ Do not use original source include files unless you know what you are doing.
 269   Use the installed members instead (in /QSYS.LIB/CURL.LIB/H.FILE).
 270
 271
 272
 273 ILE/RPG support:
 274
 275   Since 95% of the OS/400 programmers use ILE/RPG exclusively, a definition
 276   /INCLUDE member is provided for this language. To include all libcurl
 277   definitions in an ILE/RPG module, line
 278
 279      h bnddir('CURL/CURL')
 280
 281 must figure in the program header, and line
 282
 283      d/include curl/h,curl.inc
 284
 285 in the global data section of the module's source code.
 286
 287   No vararg procedure support exists in ILE/RPG: for this reason, the following
 288 considerations apply:
 289 _ Procedures curl_easy_setopt_long(), curl_easy_setopt_object(),
 290   curl_easy_setopt_function() and curl_easy_setopt_offset() are all alias
 291   prototypes to curl_easy_setopt(), but with different parameter lists.
 292 _ Procedures curl_easy_getinfo_string(), curl_easy_getinfo_long(),
 293   curl_easy_getinfo_double() and curl_easy_getinfo_slist() are all alias
 294   prototypes to curl_easy_getinfo(), but with different parameter lists.
 295 _ Procedures curl_multi_setopt_long(), curl_multi_setopt_object(),
 296   curl_multi_setopt_function() and curl_multi_setopt_offset() are all alias
 297   prototypes to curl_multi_setopt(), but with different parameter lists.
 298 _ The prototype of procedure curl_formadd() allows specifying a pointer option
 299   and the CURLFORM_END option. This makes possible to use an option array
 300   without any additional definition. If some specific incompatible argument
 301   list is used in the ILE/RPG program, the latter must define a specialised
 302   alias. The same applies to curl_formadd_ccsid() too.
 303
 304   Since RPG cannot cast a long to a pointer, procedure curl_form_long_value()
 305 is provided for that purpose: this allows storing a long value in the curl_forms
 306 array.