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   Three SSL implementations were present in libcurl. Nevertheless, none of them
  43 is available on OS/400. To support SSL on OS/400, a fourth implementation has
  44 been added (qssl.[ch]). There is no way to have different certificate stores
  45 for CAs and for personal/application certificates/key. More, the SSL context
  46 may be defined as an application identifier in the main certificate store,
  47 or as a keyring file. As a consequence, the meaning of some fields have been
  48 slightly altered:
  49 _ The "certificate identifier" is taken from CURLOPT_SSLCERT if defined, else
  50 from CURLOPT_CAINFO.
  51 _ The certificate identifier is then used as an application identifier in the
  52 main certificate store. If successful, this context is used.
  53 _ If the previous step failed, the certificate identifier is used as the file
  54 name of a keyring. CURLOPT_KEYPASSWD is used here as the keyring password.
  55 _ The default ca-bundle (CURLOPT_CAINFO) is set to the main certificate store's
  56 keyring file name: this allows to use the system global CAs by default. (In that
  57 case, the keyring password is safely recovered from the system... IBM dixit!)
  58
  59   Non-standard EBCDIC wrapper prototypes are defined in an additional header
  60 file: ccsidcurl.h. These should be self-explanatory to an OS/400-aware
  61 designer. CCSID 0 can be used to select the current job's CCSID.
  62   Wrapper procedures with variable arguments are described below:
  63
  64 _ curl_easy_setopt_ccsid()
  65   Variable arguments are a string pointer and a CCSID (unsigned int) for
  66 options:
  67         CURLOPT_CAINFO
  68         CURLOPT_CAPATH
  69         CURLOPT_COOKIE
  70         CURLOPT_COOKIEFILE
  71         CURLOPT_COOKIEJAR
  72         CURLOPT_COOKIELIST
  73         CURLOPT_CUSTOMREQUEST
  74         CURLOPT_EGDSOCKET
  75         CURLOPT_ENCODING
  76         CURLOPT_FTPPORT
  77         CURLOPT_FTP_ACCOUNT
  78         CURLOPT_FTP_ALTERNATIVE_TO_USER
  79         CURLOPT_INTERFACE
  80         CURLOPT_KEYPASSWD
  81         CURLOPT_KRBLEVEL
  82         CURLOPT_NETRC_FILE
  83         CURLOPT_COPYPOSTFIELDS
  84         CURLOPT_PROXY
  85         CURLOPT_PROXYUSERPWD
  86         CURLOPT_RANDOM_FILE
  87         CURLOPT_RANGE
  88         CURLOPT_REFERER
  89         CURLOPT_SSH_PRIVATE_KEYFILE
  90         CURLOPT_SSH_PUBLIC_KEYFILE
  91         CURLOPT_SSLCERT
  92         CURLOPT_SSLCERTTYPE
  93         CURLOPT_SSLENGINE
  94         CURLOPT_SSLKEY
  95         CURLOPT_SSLKEYTYPE
  96         CURLOPT_SSL_CIPHER_LIST
  97         CURLOPT_URL
  98         CURLOPT_USERAGENT
  99         CURLOPT_USERPWD
 100         CURLOPT_SSH_HOST_PUBLIC_KEY_MD5
 101         CURLOPT_CRLFILE
 102         CURLOPT_ISSUERCERT
 103         CURLOPT_USERNAME
 104         CURLOPT_PASSWORD
 105         CURLOPT_PROXYUSERNAME
 106         CURLOPT_PROXYPASSWORD
 107         CURLOPT_NOPROXY
 108         CURLOPT_RTSP_SESSION_UID
 109         CURLOPT_RTSP_STREAM_URI
 110         CURLOPT_RTSP_TRANSPORT
 111         CURLOPT_SOCKS5_GSSAPI_SERVICE
 112         CURLOPT_MAIL_FROM
 113         CURLOPT_TLSAUTH_USERNAME
 114         CURLOPT_TLSAUTH_PASSWORD
 115         CURLOPT_TLSAUTH_TYPE
 116   Else it is the same as for curl_easy_setopt().
 117   Note that CURLOPT_ERRORBUFFER is not in the list above, since it gives the
 118 address of an (empty) character buffer, not the address of a string.
 119 CURLOPT_POSTFIELDS stores the address of static binary data (of type void *) and
 120 thus is not converted. If CURLOPT_COPYPOSTFIELDS is issued after
 121 CURLOPT_POSTFIELDSIZE != -1, the data size is adjusted according to the
 122 CCSID conversion result length.
 123
 124 _ curl_formadd_ccsid()
 125   In the variable argument list, string pointers should be followed by a (long)
 126 CCSID for the following options:
 127         CURLFORM_FILENAME
 128         CURLFORM_CONTENTTYPE
 129         CURLFORM_BUFFER
 130         CURLFORM_FILE
 131         CURLFORM_FILECONTENT
 132         CURLFORM_COPYCONTENTS
 133         CURLFORM_COPYNAME
 134         CURLFORM_PTRNAME
 135   If taken from an argument array, an additional array entry must follow each
 136 entry containing one of the above option. This additional entry holds the CCSID
 137 in its value field, and the option field is meaningless.
 138   It is not possible to have a string pointer and its CCSID across a function
 139 parameter/array boundary.
 140   Please note that CURLFORM_PTRCONTENTS and CURLFORM_BUFFERPTR are considered
 141 unconvertible strings and thus are NOT followed by a CCSID.
 142
 143 _ curl_easy_getinfo_ccsid
 144   The following options are followed by a 'char * *' and a CCSID. Unlike
 145 curl_easy_getinfo(), the value returned in the pointer should be freed after
 146 use:
 147         CURLINFO_EFFECTIVE_URL
 148         CURLINFO_CONTENT_TYPE
 149         CURLINFO_FTP_ENTRY_PATH
 150         CURLINFO_REDIRECT_URL
 151         CURLINFO_PRIMARY_IP
 152         CURLINFO_RTSP_SESSION_ID
 153         CURLINFO_LOCAL_IP
 154   Other options are processed like in curl_easy_getinfo().
 155
 156   Standard compilation environment does support neither autotools nor make;
 157 in fact, very few common utilities are available. As a consequence, the
 158 config-os400.h has been coded manually and the compilation scripts are
 159 a set of shell scripts stored in subdirectory packages/OS400.
 160
 161   The "curl" command and the test environment are currently not supported on
 162 OS/400.
 163
 164
 165 Protocols currently implemented on OS/400:
 166 _ DICT
 167 _ FILE
 168 _ FTP
 169 _ FTPS
 170 _ FTP with secure transmission
 171 _ GOPHER
 172 _ HTTP
 173 _ HTTPS
 174 _ IMAP
 175 _ IMAPS
 176 _ IMAP with secure transmission
 177 _ LDAP
 178 _ POP3
 179 _ POP3S
 180 _ POP3 with secure transmission
 181 _ RTSP
 182 _ SMTP
 183 _ SMTPS
 184 _ SMTP with secure transmission
 185 _ TELNET
 186 _ TFTP
 187
 188
 189
 190 Compiling on OS/400:
 191
 192   These instructions targets people who knows about OS/400, compiling, IFS and
 193 archive extraction. Do not ask questions about these subjects if you're not
 194 familiar with.
 195
 196 _ As a prerequisite, QADRT development environment must be installed.
 197 _ Install the curl source directory in IFS.
 198 _ Enter shell (QSH)
 199 _ Change current directory to the curl installation directory
 200 _ Change current directory to ./packages/OS400
 201 _ Edit file iniscript.sh. You may want to change tunable configuration
 202   parameters, like debug info generation, optimisation level, listing option,
 203   target library, etc.
 204 _ Copy any file in the current directory to makelog (i.e.:
 205   cp initscript.sh makelog): this is intended to create the makelog file with
 206   an ASCII CCSID!
 207 _ Enter the command "sh makefile.sh > makelog 2>&1'
 208 _ Examine the makelog file to check for compilation errors.
 209
 210   Leaving file initscript.sh unchanged, this will produce the following OS/400
 211 objects:
 212 _ Library CURL. All other objects will be stored in this library.
 213 _ Modules for all libcurl units.
 214 _ Binding directory CURL_A, to be used at calling program link time for
 215   statically binding the modules (specify BNDSRVPGM(QADRTTS QGLDCLNT QGLDBRDR)
 216   when creating a program using CURL_A).
 217 _ Service program CURL.<soname>, where <soname> is extracted from the
 218   lib/Makefile.am VERSION variable. To be used at calling program run-time
 219   when this program has dynamically bound curl at link time.
 220 _ Binding directory CURL. To be used to dynamically bind libcurl when linking a
 221   calling program.
 222 _ Source file H. It contains all the include members needed to compile a C/C++
 223   module using libcurl, and an ILE/RPG /copy member for support in this
 224   language.
 225 _ Standard C/C++ libcurl include members in file H.
 226 _ CCSIDCURL member in file H. This defines the non-standard EBCDIC wrappers for
 227   C and C++.
 228 _ CURL.INC member in file H. This defines everything needed by an ILE/RPG
 229   program using libcurl.
 230 _ LIBxxx modules and programs. Although the test environment is not supported
 231   on OS/400, the libcurl test programs are compiled for manual tests.
 232
 233
 234
 235 Special programming consideration:
 236
 237 QADRT being used, the following points must be considered:
 238 _ If static binding is used, service program QADRTTS must be linked too.
 239 _ The EBCDIC CCSID used by QADRT is 37 by default, NOT THE JOB'S CCSID. If
 240   another EBCDIC CCSID is required, it must be set via a locale through a call
 241   to setlocale_a (QADRT's setlocale() ASCII wrapper) with category LC_ALL or
 242   LC_CTYPE, or by setting environment variable QADRT_ENV_LOCALE to the locale
 243   object path before executing the program.
 244 _ Do not use original source include files unless you know what you are doing.
 245   Use the installed members instead (in /QSYS.LIB/CURL.LIB/H.FILE).
 246
 247
 248
 249 ILE/RPG support:
 250
 251   Since 95% of the OS/400 programmers use ILE/RPG exclusively, a definition
 252   /COPY member is provided for this language. To include all libcurl
 253   definitions in an ILE/RPG module, line
 254
 255      h bnddir('CURL/CURL')
 256
 257 must figure in the program header, and line
 258
 259      d/copy curl/h,curl.inc
 260
 261 in the global data section of the module's source code.
 262
 263   No vararg procedure support exists in ILE/RPG: for this reason, the following
 264 considerations apply:
 265 _ Procedures curl_easy_setopt_long(), curl_easy_setopt_object(),
 266   curl_easy_setopt_function() and curl_easy_setopt_offset() are all alias
 267   prototypes to curl_easy_setopt(), but with different parameter lists.
 268 _ Procedures curl_easy_getinfo_string(), curl_easy_getinfo_long(),
 269   curl_easy_getinfo_double() and curl_easy_getinfo_slist() are all alias
 270   prototypes to curl_easy_getinfo(), but with different parameter lists.
 271 _ Procedures curl_multi_setopt_long(), curl_multi_setopt_object(),
 272   curl_multi_setopt_function() and curl_multi_setopt_offset() are all alias
 273   prototypes to curl_multi_setopt(), but with different parameter lists.
 274 _ The prototype of procedure curl_formadd() allows specifying a pointer option
 275   and the CURLFORM_END option. This makes possible to use an option array
 276   without any additional definition. If some specific incompatible argument
 277   list is used in the ILE/RPG program, the latter must define a specialised
 278   alias. The same applies to curl_formadd_ccsid() too.
 279
 280   Since RPG cannot cast a long to a pointer, procedure curl_form_long_value()
 281 is provided for that purpose: this allows storing a long value in the curl_forms
 282 array.