http.h 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. /*
  2. * Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
  3. * Copyright Siemens AG 2018-2020
  4. *
  5. * Licensed under the Apache License 2.0 (the "License"). You may not use
  6. * this file except in compliance with the License. You can obtain a copy
  7. * in the file LICENSE in the source distribution or at
  8. * https://www.openssl.org/source/license.html
  9. */
  10. #ifndef OPENSSL_HTTP_H
  11. # define OPENSSL_HTTP_H
  12. # pragma once
  13. # include <openssl/opensslconf.h>
  14. # include <openssl/bio.h>
  15. # include <openssl/asn1.h>
  16. # include <openssl/conf.h>
  17. # ifdef __cplusplus
  18. extern "C" {
  19. # endif
  20. # define OSSL_HTTP_NAME "http"
  21. # define OSSL_HTTPS_NAME "https"
  22. # define OSSL_HTTP_PREFIX OSSL_HTTP_NAME"://"
  23. # define OSSL_HTTPS_PREFIX OSSL_HTTPS_NAME"://"
  24. # define OSSL_HTTP_PORT "80"
  25. # define OSSL_HTTPS_PORT "443"
  26. # define OPENSSL_NO_PROXY "NO_PROXY"
  27. # define OPENSSL_HTTP_PROXY "HTTP_PROXY"
  28. # define OPENSSL_HTTPS_PROXY "HTTPS_PROXY"
  29. #define OSSL_HTTP_DEFAULT_MAX_LINE_LEN (4 * 1024)
  30. #define OSSL_HTTP_DEFAULT_MAX_RESP_LEN (100 * 1024)
  31. /* Low-level HTTP API */
  32. OSSL_HTTP_REQ_CTX *OSSL_HTTP_REQ_CTX_new(BIO *wbio, BIO *rbio, int buf_size);
  33. void OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX *rctx);
  34. int OSSL_HTTP_REQ_CTX_set_request_line(OSSL_HTTP_REQ_CTX *rctx, int method_POST,
  35. const char *server, const char *port,
  36. const char *path);
  37. int OSSL_HTTP_REQ_CTX_add1_header(OSSL_HTTP_REQ_CTX *rctx,
  38. const char *name, const char *value);
  39. int OSSL_HTTP_REQ_CTX_set_expected(OSSL_HTTP_REQ_CTX *rctx,
  40. const char *content_type, int asn1,
  41. int timeout, int keep_alive);
  42. int OSSL_HTTP_REQ_CTX_set1_req(OSSL_HTTP_REQ_CTX *rctx, const char *content_type,
  43. const ASN1_ITEM *it, const ASN1_VALUE *req);
  44. int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX *rctx);
  45. int OSSL_HTTP_REQ_CTX_nbio_d2i(OSSL_HTTP_REQ_CTX *rctx,
  46. ASN1_VALUE **pval, const ASN1_ITEM *it);
  47. BIO *OSSL_HTTP_REQ_CTX_exchange(OSSL_HTTP_REQ_CTX *rctx);
  48. BIO *OSSL_HTTP_REQ_CTX_get0_mem_bio(const OSSL_HTTP_REQ_CTX *rctx);
  49. size_t OSSL_HTTP_REQ_CTX_get_resp_len(const OSSL_HTTP_REQ_CTX *rctx);
  50. void OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX *rctx,
  51. unsigned long len);
  52. int OSSL_HTTP_is_alive(const OSSL_HTTP_REQ_CTX *rctx);
  53. /* High-level HTTP API */
  54. typedef BIO *(*OSSL_HTTP_bio_cb_t)(BIO *bio, void *arg, int connect, int detail);
  55. OSSL_HTTP_REQ_CTX *OSSL_HTTP_open(const char *server, const char *port,
  56. const char *proxy, const char *no_proxy,
  57. int use_ssl, BIO *bio, BIO *rbio,
  58. OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
  59. int buf_size, int overall_timeout);
  60. int OSSL_HTTP_proxy_connect(BIO *bio, const char *server, const char *port,
  61. const char *proxyuser, const char *proxypass,
  62. int timeout, BIO *bio_err, const char *prog);
  63. int OSSL_HTTP_set1_request(OSSL_HTTP_REQ_CTX *rctx, const char *path,
  64. const STACK_OF(CONF_VALUE) *headers,
  65. const char *content_type, BIO *req,
  66. const char *expected_content_type, int expect_asn1,
  67. size_t max_resp_len, int timeout, int keep_alive);
  68. BIO *OSSL_HTTP_exchange(OSSL_HTTP_REQ_CTX *rctx, char **redirection_url);
  69. BIO *OSSL_HTTP_get(const char *url, const char *proxy, const char *no_proxy,
  70. BIO *bio, BIO *rbio,
  71. OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
  72. int buf_size, const STACK_OF(CONF_VALUE) *headers,
  73. const char *expected_content_type, int expect_asn1,
  74. size_t max_resp_len, int timeout);
  75. BIO *OSSL_HTTP_transfer(OSSL_HTTP_REQ_CTX **prctx,
  76. const char *server, const char *port,
  77. const char *path, int use_ssl,
  78. const char *proxy, const char *no_proxy,
  79. BIO *bio, BIO *rbio,
  80. OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
  81. int buf_size, const STACK_OF(CONF_VALUE) *headers,
  82. const char *content_type, BIO *req,
  83. const char *expected_content_type, int expect_asn1,
  84. size_t max_resp_len, int timeout, int keep_alive);
  85. int OSSL_HTTP_close(OSSL_HTTP_REQ_CTX *rctx, int ok);
  86. /* Auxiliary functions */
  87. int OSSL_parse_url(const char *url, char **pscheme, char **puser, char **phost,
  88. char **pport, int *pport_num,
  89. char **ppath, char **pquery, char **pfrag);
  90. int OSSL_HTTP_parse_url(const char *url, int *pssl, char **puser, char **phost,
  91. char **pport, int *pport_num,
  92. char **ppath, char **pquery, char **pfrag);
  93. const char *OSSL_HTTP_adapt_proxy(const char *proxy, const char *no_proxy,
  94. const char *server, int use_ssl);
  95. # ifdef __cplusplus
  96. }
  97. # endif
  98. #endif /* !defined(OPENSSL_HTTP_H) */