lws-whois.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2026 Andy Green <andy@warmcat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#ifndef _LWS_WHOIS_H
#define _LWS_WHOIS_H

 
/* hard cap on the size of lws_whois_json_purify() canonical output */
#define LWS_WHOIS_CANON_MAX     4096
 
/* the deadline for a whole query, if lws_whois_args.timeout_ms is 0 */
#define LWS_WHOIS_TIMEOUT_DEFAULT_MS    (20 * 1000)
/* an answer from one whois server larger than this fails the query */
#define LWS_WHOIS_ANSWER_MAX            (64 * 1024)
 
struct lws_whois_results {
        lws_usec_t              creation_date;
        lws_usec_t              expiry_date;
        lws_usec_t              updated_date;
        char                    nameservers[256];
        char                    dnssec[64];
        char                    ds_data[512];
        uint8_t                 nameservers_dropped;
};
 
typedef void (*lws_whois_cb_t)(void *opaque, const struct lws_whois_results *res);
 
struct lws_whois_args {
        struct lws_context      *context;
        const char              *domain;
        const char              *server;
        lws_whois_cb_t          cb;
        void                    *opaque;
        uint16_t                port;
        uint32_t                timeout_ms;
};

#if defined(LWS_WITH_SYS_WHOIS)
LWS_VISIBLE LWS_EXTERN int
lws_whois_query(const struct lws_whois_args *args);
#else
#define lws_whois_query(_a) (1)
#endif

#if defined(LWS_WITH_SYS_WHOIS)
LWS_VISIBLE LWS_EXTERN int
lws_whois_json_purify(char *out, size_t out_len, const char *in,
                      size_t in_len, int *problems);
#else
#define lws_whois_json_purify(_o, _ol, _i, _il, _p) ((void)(_o), -1)
#endif

#if defined(LWS_WITH_SYS_WHOIS)
LWS_VISIBLE LWS_EXTERN int
lws_whois_results_to_json(char *out, size_t out_len,
                          const struct lws_whois_results *res, int *problems);
#else
#define lws_whois_results_to_json(_o, _ol, _r, _p) ((void)(_o), -1)
#endif

 
#endif /* _LWS_WHOIS_H */