README.OS400 14 KB

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