/build/mod-whoisd-3.15.0/whois-client.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2024  CZ.NIC, z. s. p. o.
 *
 * This file is part of FRED.
 *
 * FRED is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * FRED is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with FRED.  If not, see <https://www.gnu.org/licenses/>.
 */
#ifndef WHOIS_CLIENT_H
#define WHOIS_CLIENT_H
 
#include "Logger.h"
 
#define CORBA_OK                    0 
#define CORBA_OK_LIMIT              1
#define CORBA_OK_AUCTION_PENDING    2
#define CORBA_OK_BLACKLISTED        3
#define CORBA_SERVICE_FAILED        4 
#define CORBA_INTERNAL_ERROR        5 
#define CORBA_UNKNOWN_ERROR         6 
inline int is_corba_ok(int corba_status_code)
{
    switch (corba_status_code)
    {
        case CORBA_OK:
        case CORBA_OK_LIMIT:
        case CORBA_OK_AUCTION_PENDING:
        case CORBA_OK_BLACKLISTED:
            return 1;
        default:
            return 0;
    }
}
 
#define TIME_BUFFER_LENGTH  60
#define MAX_ERROR_MSG_LEN   100
#define MAX_OBJECT_COUNT 100
 
typedef void *service_Whois;
typedef void *service_Logger;
 
#define T_NONE      0   /* Nothing. */
#define T_DOMAIN    1   /* Object type domain. */
#define T_NSSET     2   /* Object type nsset. */
#define T_CONTACT   4   /* Object type contact. */
#define T_REGISTRAR 8   /* Object type registrar. */
#define T_KEYSET    16  /* Object type keyset. */
 
typedef enum {
    SA_NONE = 0,
    SA_REGISTRANT,
    SA_ADMIN_C,
    SA_TEMP_C,
    SA_NSSET,
    SA_KEYSET,
    SA_NSERVER,
    SA_TECH_C
}search_axis;
 
/*
 * This enum reflects database table request_type
 */
typedef enum {
    Info = 1105,
} whois_action_type;
 
typedef struct {
    search_axis axe;    
    int  norecursion;   
    int  type;      
    const char  *value; 
}whois_request;
 
typedef struct {
    char     *domain;      
    char     *registrant;  
    char    **admin_c;     
    char    **temp_c;      
    char     *nsset;       
    char     *keyset;      
    char     *registrar;   
    char    **status;      
    char     *registered;  
    char     *changed;     
    char     *expire;      
    char     *validated_to;
    int  *status_ids;  
}obj_domain;
 
typedef struct {
    char     *nsset;       
    char    **nserver;     
    char    **nserver_addrs; 
    char    **tech_c;      
    char     *registrar;   
    char     *created;     
    char     *changed;     
}obj_nsset;
 
typedef struct {
    int key_tag;    
    int alg;        
    int     digest_type;    
    char   *digest;     
    int max_sig_life;   
} keyset_dsrecord;
 
typedef struct {
    int     flags;      
    int     protocol;   
    int     alg;        
    char   *public_key; 
} keyset_dnskey;
 
typedef struct {
    char    *keyset;    
    char   **tech_c;    
    keyset_dsrecord *ds;    
    keyset_dnskey   *keys;  
    char    *registrar; 
    char    *created;   
    char    *changed;   
} obj_keyset;
 
typedef struct {
    char     *contact;     
    char     *org;         
    char     *name;        
    char    **address;     
    char     *phone;       
    char     *fax_no;      
    char     *e_mail;      
    char     *registrar;   
    char     *created;     
    char     *changed;     
    int       disclose;    
}obj_contact;
 
typedef struct {
    char     *registrar;   
    char     *org;         
    char     *url;         
    char     *phone;       
    char    **address;     
}obj_registrar;
 
typedef struct {
    int  type;         
    union {
        obj_domain  d;
        obj_nsset   n;
        obj_keyset  k;
        obj_contact c;
        obj_registrar   r;
    }obj;           
}general_object;
 
typedef struct {
    int size;
    char **requested_by;
} exception_blacklisted_data_t;
 
int
whois_corba_call(service_Whois service,
        const whois_request *wr,
        general_object *objects,
        char *timebuf,
        char *errmsg,
        void **exception_data);
 
void whois_release_data(general_object *object_list);
 
int check_duplicates(int type, char *handle, general_object *objects, int index_free);
 
int
whois_log_new_message(service_Logger service,
        const char *sourceIP,
        const char *content,
        ccReg_RequestProperties *properties,
        ccReg_TID *log_entry_id,
        char *errmsg);
 
int
whois_close_log_message(service_Logger service,
        const char *content,
        ccReg_RequestProperties *properties,
        ccReg_TID log_entry_id,
        CORBA_long result_code,
        char *errmsg);
 
#endif /* WHOIS_CLIENT_H */