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