epp_common.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2007  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, version 2 of the License.
 *
 *  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 <http://www.gnu.org/licenses/>.
 */
#ifndef EPP_COMMON_H
#define EPP_COMMON_H

typedef enum {
    EPP_FATAL = 1, 
    EPP_ERROR, 
    EPP_WARNING, 
    EPP_INFO, 
    EPP_DEBUG 
} epp_loglevel;

typedef struct
{
    void *pool; 
    void *conn; 
    int session;
} epp_context;

typedef enum {
    EPP_UNKNOWN_CMD = 0,
    /*
     * 'dummy' is not a command from point of view of epp client, but is
     * command from central repository's point of view
     */
    EPP_DUMMY,
    /* session commands */
    EPP_LOGIN,
    EPP_LOGOUT,
    /* query commands */
    EPP_CHECK_CONTACT,
    EPP_CHECK_DOMAIN,
    EPP_CHECK_NSSET,
    EPP_CHECK_KEYSET,
    EPP_INFO_CONTACT,
    EPP_INFO_DOMAIN,
    EPP_INFO_NSSET,
    EPP_INFO_KEYSET,
    EPP_LIST_CONTACT,
    EPP_LIST_DOMAIN,
    EPP_LIST_NSSET,
    EPP_LIST_KEYSET,
    EPP_POLL_REQ,
    EPP_POLL_ACK,
    /* transform commands */
    EPP_CREATE_CONTACT,
    EPP_CREATE_DOMAIN,
    EPP_CREATE_NSSET,
    EPP_CREATE_KEYSET,
    EPP_DELETE_CONTACT,
    EPP_DELETE_DOMAIN,
    EPP_DELETE_NSSET,
    EPP_DELETE_KEYSET,
    EPP_UPDATE_CONTACT,
    EPP_UPDATE_DOMAIN,
    EPP_UPDATE_NSSET,
    EPP_UPDATE_KEYSET,
    EPP_TRANSFER_CONTACT,
    EPP_TRANSFER_DOMAIN,
    EPP_TRANSFER_NSSET,
    EPP_TRANSFER_KEYSET,
    EPP_RENEW_DOMAIN,
    /* protocol extensions */
    EPP_SENDAUTHINFO_CONTACT,
    EPP_SENDAUTHINFO_DOMAIN,
    EPP_SENDAUTHINFO_NSSET,
    EPP_SENDAUTHINFO_KEYSET,
    EPP_TEST_NSSET,
    EPP_CREDITINFO,
    /* info functions */
    EPP_INFO_LIST_CONTACTS,
    EPP_INFO_LIST_DOMAINS,
    EPP_INFO_LIST_NSSETS,
    EPP_INFO_LIST_KEYSETS,
    EPP_INFO_DOMAINS_BY_NSSET,
    EPP_INFO_DOMAINS_BY_KEYSET,
    EPP_INFO_DOMAINS_BY_CONTACT,
    EPP_INFO_NSSETS_BY_CONTACT,
    EPP_INFO_NSSETS_BY_NS,
    EPP_INFO_KEYSETS_BY_CONTACT,
    EPP_INFO_GET_RESULTS
} epp_command_type;

typedef enum { EPP_EXT_ENUMVAL, EPP_EXT_MAILING_ADDR } epp_ext_type;

typedef enum {
    EPP_UNKNOWN_OBJ = 0,
    EPP_CONTACT,
    EPP_DOMAIN,
    EPP_NSSET,
    EPP_KEYSET
} epp_object_type;

typedef enum {
    LANG_EN = 0,
    LANG_CS,
} epp_lang;

typedef enum {
    errspec_poll_msgID = 0,
    errspec_contact_handle,
    errspec_contact_cc,
    errspec_nsset_handle,
    errspec_nsset_tech,
    errspec_nsset_dns_name,
    errspec_nsset_dns_addr,
    errspec_nsset_dns_name_add,
    errspec_nsset_dns_name_rem,
    errspec_nsset_tech_add,
    errspec_nsset_tech_rem,
    errspec_keyset_handle,
    errspec_keyset_tech,
    errspec_keyset_dnskey,
    errspec_keyset_dnskey_add,
    errspec_keyset_dnskey_rem,
    errspec_keyset_tech_add,
    errspec_keyset_tech_rem,
    errspec_registrar_author,
    errspec_domain_fqdn,
    errspec_domain_registrant,
    errspec_domain_nsset,
    errspec_domain_keyset,
    errspec_domain_period,
    errspec_domain_admin,
    errspec_domain_tmpcontact,
    errspec_domain_ext_valDate,
    errspec_domain_ext_valDate_missing,
    errspec_domain_curExpDate,
    errspec_domain_admin_add,
    errspec_domain_admin_rem,
    /* input errors */
    errspec_not_valid,
    errspec_poll_msgID_missing,
    errspec_contact_identtype_missing,
    errspec_transfer_op
} epp_errorspec;

typedef struct
{
    char *value;
    epp_errorspec spec;
    char *reason;
    int position;
} epp_error;

typedef enum
{
    incorrect_epp_action_type = 0,
    ClientLogin = 100,
    ClientLogout = 101,
    ClientGreeting = 105,
    PollAcknowledgement = 120,
    PollResponse = 121,
    ContactCheck = 200,
    ContactInfo = 201,
    ContactDelete = 202,
    ContactUpdate = 203,
    ContactCreate = 204,
    ContactTransfer = 205,
    NSsetCheck = 400,
    NSsetInfo = 401,
    NSsetDelete = 402,
    NSsetUpdate = 403,
    NSsetCreate = 404,
    NSsetTransfer = 405,
    DomainCheck = 500,
    DomainInfo = 501,
    DomainDelete = 502,
    DomainUpdate = 503,
    DomainCreate = 504,
    DomainTransfer = 505,
    DomainRenew = 506,
    DomainTrade = 507,
    KeysetCheck = 600,
    KeysetInfo = 601,
    KeysetDelete = 602,
    KeysetUpdate = 603,
    KeysetCreate = 604,
    KeysetTransfer = 605,
    UnknownAction = 1000,
    ListContact = 1002,
    ListNSset = 1004,
    ListDomain = 1005,
    ListKeySet = 1006,
    ClientCredit = 1010,
    nssetTest = 1012,
    ContactSendAuthInfo = 1101,
    NSSetSendAuthInfo = 1102,
    DomainSendAuthInfo = 1103,
    KeySetSendAuthInfo = 1106,
    InfoListContacts = 1200,
    InfoListDomains = 1201,
    InfoListNssets = 1202,
    InfoListKeysets = 1203,
    InfoDomainsByNsset = 1204,
    InfoDomainsByKeyset = 1205,
    InfoDomainsByContact = 1206,
    InfoNssetsByContact = 1207,
    InfoNssetsByNs = 1208,
    InfoKeysetsByContact = 1209,
    InfoGetResults = 1210
} epp_action_type;

typedef struct qitem
{
    struct qitem *next; 
    void *content; 
} qitem;

typedef struct
{
    int count; 
    qitem *body; 
    qitem *cur; 
} qhead;

#define q_length(_qhead) ((_qhead).count)

#define q_next(_qhead) ((_qhead)->cur = ((_qhead)->cur) ? (_qhead)->cur->next : NULL)

#define q_content(_qhead) ((_qhead)->cur->content)

#define q_reset(_qhead) ((_qhead)->cur = (_qhead)->body)

#define q_foreach(_qhead)                                                                          \
    for ((_qhead)->cur = (_qhead)->body; (_qhead)->cur != NULL; (_qhead)->cur = (_qhead)->cur->next)

int q_add(void *pool, qhead *head, void *data);

/* ********************************************************************* */


typedef struct
{
    char *value; 
    char *text; 
} epp_status;

typedef struct
{
    char *name; 
    char *org; 
    qhead streets; 
    char *city; 
    char *sp; 
    char *pc; 
    char *cc; 
} epp_postalInfo;

typedef struct
{
    char flag;
    unsigned char name; 
    unsigned char org; 
    unsigned char addr; 
    unsigned char voice; 
    unsigned char fax; 
    unsigned char email; 
    unsigned char vat; 
    unsigned char ident; 
    unsigned char notifyEmail;
} epp_discl;

typedef struct
{
    char *name; 
    qhead addr; 
} epp_ns;

typedef struct
{
    unsigned short flags; 
    unsigned char protocol; 
    unsigned char alg; 
    char *public_key; 
} epp_dnskey;

typedef enum {
    ident_UNKNOWN, 
    ident_OP, 
    ident_PASSPORT, 
    ident_MPSV, 
    ident_ICO, 
    ident_BIRTHDAY 
} epp_identType;

typedef enum { TIMEUNIT_MONTH, TIMEUNIT_YEAR } epp_timeunit;

typedef struct
{
    int avail; 
    char *reason; 
} epp_avail;

typedef struct
{
    char *zone; 
    char *credit; 
} epp_zonecredit;

typedef struct
{
    char *ext_enumval; 
    int publish; 
} epp_ext_enum;

typedef struct
{
    char *Street1; 
    char *Street2; 
    char *Street3; 
    char *City; 
    char *StateOrProvince; 
    char *PostalCode; 
    char *CountryCode; 
} epp_mailingAddr;

typedef enum { mailing_addr_info, mailing_addr_set, mailing_addr_remove } epp_mailingAddrCommand;

typedef epp_mailingAddr epp_ext_mailingAddr_set;
typedef epp_mailingAddr epp_ext_mailingAddr_info;
typedef struct
{
} epp_ext_mailingAddr_remove;

typedef struct
{
    epp_mailingAddrCommand command;
    union
    {
        epp_ext_mailingAddr_info info;
        epp_ext_mailingAddr_set set;
        epp_ext_mailingAddr_remove remove;
    } data;
} epp_ext_mailingAddr;


typedef struct
{
    epp_ext_type extType; 
    union
    {
        epp_ext_enum ext_enum; 
        epp_ext_mailingAddr ext_mailing_addr; 
    } ext; 
} epp_ext_item;

typedef enum {
    pt_transfer_contact, 
    pt_delete_contact, 
    pt_transfer_nsset, 
    pt_delete_nsset, 
    pt_transfer_keyset, 
    pt_delete_keyset, 
    pt_techcheck, 
    pt_transfer_domain, 
    pt_impexpiration, 
    pt_expiration, 
    pt_impvalidation, 
    pt_validation, 
    pt_outzone, 
    pt_delete_domain, 
    pt_lowcredit, 
    pt_request_fee_info, 
    pt_update_contact, 
    pt_update_domain, 
    pt_update_nsset, 
    pt_update_keyset 
} epp_pollType;

typedef struct
{
    char *testname;
    int status;
    char *note;
} epp_testResult;

/* ********************************************************************* */


typedef struct
{
    char *clID; 
    char *pw; 
    char *newPW; 
    qhead objuri; 
    qhead exturi; 
    unsigned lang; 
} epps_login;

typedef struct
{
    qhead ids; 
    qhead avails; 
} epps_check;

typedef struct
{
    char *id; 
    char *handle; 
    char *roid; 
    qhead status; 
    epp_postalInfo pi; 
    char *voice; 
    char *fax; 
    char *email; 
    char *clID; 
    char *crID; 
    char *crDate; 
    char *upID; 
    char *upDate; 
    char *trDate; 
    char *authInfo; 
    epp_discl discl; 
    char *vat; 
    char *ident; 
    epp_identType identtype; 
    char *notify_email; 
    qhead extensions; 
} epps_info_contact;

typedef struct
{
    char *name; 
    char *handle; 
    char *roid; 
    qhead status; 
    char *registrant; 
    qhead tmpcontact; 
    qhead admin; 
    char *nsset; 
    char *keyset; 
    char *clID; 
    char *crID; 
    char *crDate; 
    char *exDate; 
    char *upID; 
    char *upDate; 
    char *trDate; 
    char *authInfo; 
    qhead extensions; 
} epps_info_domain;

typedef struct
{
    char *id; 
    char *handle; 
    char *roid; 
    qhead status; 
    char *clID; 
    char *crID; 
    char *crDate; 
    char *upID; 
    char *upDate; 
    char *trDate; 
    char *authInfo; 
    qhead ns; 
    qhead tech; 
    int level; 
} epps_info_nsset;

typedef struct
{
    char *id; 
    char *handle; 
    char *roid; 
    qhead status; 
    char *clID; 
    char *crID; 
    char *crDate; 
    char *upID; 
    char *upDate; 
    char *trDate; 
    char *authInfo; 
    qhead keys; 
    qhead tech; 
} epps_info_keyset;

typedef struct
{
    unsigned long long count; 
    char *msgid; 
    char *qdate; 
    epp_pollType type; 
    union
    {
        char *handle;
        struct
        {
            char *handle;
            char *date;
            char *clID;
        } hdt; 
        struct
        {
            char *handle;
            char *date;
        } hd; 
        struct
        {
            char *handle;
            qhead fqdns;
            qhead tests;
        } tc; 
        struct
        {
            char *zone;
            char *limit;
            char *credit;
        } lc; 
        struct
        {
            char *period_from;
            char *period_to;
            unsigned long long total_free_count;
            unsigned long long used_count;
            char *price;
        } rfi; 
        struct
        {
            char *optrid;
            unsigned long long pollid;
            epps_info_contact old_data;
            epps_info_contact new_data;
        } upc; 
        struct
        {
            char *optrid;
            unsigned long long pollid;
            epps_info_domain old_data;
            epps_info_domain new_data;
        } upd; 
        struct
        {
            char *optrid;
            unsigned long long pollid;
            epps_info_nsset old_data;
            epps_info_nsset new_data;
        } upn; 
        struct
        {
            char *optrid;
            unsigned long long pollid;
            epps_info_keyset old_data;
            epps_info_keyset new_data;
        } upk; 
    } msg; 
} epps_poll_req;

typedef struct
{
    char *msgid; 
    unsigned long long count; 
    char *newmsgid; 
} epps_poll_ack;

typedef struct
{
    char *id; 
    epp_postalInfo pi; 
    char *voice; 
    char *fax; 
    char *email; 
    char *authInfo; 
    epp_discl discl; 
    char *vat; 
    char *ident; 
    epp_identType identtype; 
    char *notify_email; 
    char *crDate; 
    qhead extensions; 
} epps_create_contact;

typedef struct
{
    char *name; 
    char *registrant; 
    qhead admin; 
    char *nsset; 
    char *keyset; 
    int period; 
    epp_timeunit unit; 
    char *authInfo; 
    qhead extensions; 
    char *crDate; 
    char *exDate; 
} epps_create_domain;

typedef struct
{
    char *id; 
    char *authInfo; 
    qhead ns; 
    qhead tech; 
    char *crDate; 
    int level; 
} epps_create_nsset;

typedef struct
{
    char *id; 
    char *authInfo; 
    qhead keys; 
    qhead tech; 
    char *crDate; 
} epps_create_keyset;

typedef struct
{
    char *id; 
} epps_delete;

typedef struct
{
    char *name; 
    char *curExDate; 
    int period; 
    epp_timeunit unit; 
    qhead extensions; 
    char *exDate; 
} epps_renew;

typedef struct
{
    char *id; 
    epp_postalInfo *pi; 
    char *voice; 
    char *fax; 
    char *email; 
    char *authInfo; 
    epp_discl discl; 
    char *vat; 
    char *ident; 
    epp_identType identtype; 
    char *notify_email; 
    qhead extensions; 
} epps_update_contact;

typedef struct
{
    char *name; 
    char *registrant; 
    qhead add_admin; 
    qhead rem_admin; 
    qhead rem_tmpcontact; 
    char *nsset; 
    char *keyset; 
    char *authInfo; 
    qhead extensions; 
} epps_update_domain;

typedef struct
{
    char *id; 
    qhead add_tech; 
    qhead rem_tech; 
    qhead add_ns; 
    qhead rem_ns; 
    char *authInfo; 
    int level; 
} epps_update_nsset;

typedef struct
{
    char *id; 
    qhead add_tech; 
    qhead rem_tech; 
    qhead add_dnskey; 
    qhead rem_dnskey; 
    char *authInfo; 
} epps_update_keyset;

typedef struct
{
    char *id; 
    char *authInfo; 
} epps_transfer;

typedef struct
{
    char *id; 
} epps_sendAuthInfo;

typedef struct
{
    qhead zonecredits; 
} epps_creditInfo;

typedef struct
{
    char *id; 
    qhead names; 
    int level; 
} epps_test;

typedef struct
{
    qhead handles; 
} epps_list;

typedef struct
{
    char *handle; 
    unsigned int count; 
} epps_info;

typedef struct
{
    char *clTRID; 
    char *svTRID; 
    int rc; 
    char *msg; 
    char *xml_in; 
    /* parsed_doc and xpath_ctx are needed for error reporting. */
    void *parsed_doc; 
    void *xpath_ctx; 
    short noresdata;
    qhead errors;

    epp_command_type type;
    void *data;
} epp_command_data;


/* ********************************************************************* */

void epplog(epp_context *epp_ctx, epp_loglevel level, const char *fmt, ...);

void *epp_malloc(void *pool, unsigned size);

void *epp_calloc(void *pool, unsigned size);

char *epp_strdup(void *pool, const char *str);

char *epp_strcat(void *pool, const char *str1, const char *str2);

char *epp_sprintf(void *pool, const char *fmt, ...);

#endif /* EPP_COMMON_H */