uclient.h

   1 /*
   2  * uclient - ustream based protocol client library
   3  *
   4  * Copyright (C) 2014 Felix Fietkau <nbd@openwrt.org>
   5  *
   6  * Permission to use, copy, modify, and/or distribute this software for any
   7  * purpose with or without fee is hereby granted, provided that the above
   8  * copyright notice and this permission notice appear in all copies.
   9  *
  10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17  */
  18 #ifndef __LIBUBOX_UCLIENT_H
  19 #define __LIBUBOX_UCLIENT_H
  20
  21 #include <netinet/in.h>
  22
  23 #include <libubox/blob.h>
  24 #include <libubox/ustream.h>
  25 #include <libubox/ustream-ssl.h>
  26
  27 struct uclient_cb;
  28 struct uclient_backend;
  29
  30 enum uclient_error_code {
  31         UCLIENT_ERROR_UNKNOWN,
  32         UCLIENT_ERROR_CONNECT,
  33         UCLIENT_ERROR_SSL_INVALID_CERT,
  34         UCLIENT_ERROR_SSL_CN_MISMATCH,
  35         UCLIENT_ERROR_MISSING_SSL_CONTEXT,
  36 };
  37
  38 union uclient_addr {
  39         struct sockaddr sa;
  40         struct sockaddr_in sin;
  41         struct sockaddr_in6 sin6;
  42 };
  43
  44 struct uclient_url {
  45         const struct uclient_backend *backend;
  46         int prefix;
  47
  48         const char *host;
  49         const char *port;
  50         const char *location;
  51
  52         const char *auth;
  53 };
  54
  55 struct uclient {
  56         const struct uclient_backend *backend;
  57         const struct uclient_cb *cb;
  58
  59         union uclient_addr local_addr, remote_addr;
  60
  61         struct uclient_url *url;
  62         void *priv;
  63
  64         bool eof;
  65         int error_code;
  66         int status_code;
  67         struct blob_attr *meta;
  68
  69         struct uloop_timeout timeout;
  70 };
  71
  72 struct uclient_cb {
  73         void (*data_read)(struct uclient *cl);
  74         void (*data_sent)(struct uclient *cl);
  75         void (*data_eof)(struct uclient *cl);
  76         void (*header_done)(struct uclient *cl);
  77         void (*error)(struct uclient *cl, int code);
  78 };
  79
  80 struct uclient *uclient_new(const char *url, const char *auth_str, const struct uclient_cb *cb);
  81 void uclient_free(struct uclient *cl);
  82
  83 int uclient_set_url(struct uclient *cl, const char *url, const char *auth);
  84 int uclient_connect(struct uclient *cl);
  85 void uclient_disconnect(struct uclient *cl);
  86
  87 int uclient_read(struct uclient *cl, char *buf, int len);
  88 int uclient_write(struct uclient *cl, char *buf, int len);
  89 int uclient_request(struct uclient *cl);
  90
  91 char *uclient_get_addr(char *dest, int *port, union uclient_addr *a);
  92
  93 /* HTTP */
  94 extern const struct uclient_backend uclient_backend_http;
  95
  96 int uclient_http_reset_headers(struct uclient *cl);
  97 int uclient_http_set_header(struct uclient *cl, const char *name, const char *value);
  98 int uclient_http_set_request_type(struct uclient *cl, const char *type);
  99 bool uclient_http_redirect(struct uclient *cl);
 100
 101 int uclient_http_set_ssl_ctx(struct uclient *cl, const struct ustream_ssl_ops *ops,
 102                              struct ustream_ssl_ctx *ctx, bool require_validation);
 103
 104 #endif