Client and Server SSL options

Server Certificate Verification

"Net::EPP::Simple" will verify the certificate presented by a server if the "verify", and either "ca_file" or "ca_path" are passed to the constructor:

        my $epp = Net::EPP::Simple->new(
                host    => 'epp.nic.tld',
                user    => 'my-id',
                pass    => 'my-password',
                verify  => 1,
                ca_file => '/etc/pki/tls/certs/ca-bundle.crt',
                ca_path => '/etc/pki/tls/certs',
        );

"Net::EPP::Simple" will fail to connect to the server if the certificate is not valid.

You can disable SSL certificate verification by omitting the "verify" argument or setting it to "undef". This is strongly discouraged, particularly in production environments.

SSL Cipher Selection

You can restrict the ciphers that you will use to connect to the server by passing a "ciphers" parameter to the constructor. This is a colon- separated list of cipher names and aliases. See <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_STRINGS> for further details. As an example, the following cipher list is suggested for clients who wish to ensure high-security connections to servers:

        HIGH:!ADH:!MEDIUM:!LOW:!SSLv2:!EXP

Client Certificates

If you are connecting to an EPP server which requires a client certificate, you can configure "Net::EPP::Simple" to use one as follows:

        my $epp = Net::EPP::Simple->new(
                host            => 'epp.nic.tld',
                user            => 'my-id',
                pass            => 'my-password',
                key             => '/path/to/my.key',
                cert            => '/path/to/my.crt',
                passphrase      => 'foobar123',
        );

"key" is the filename of the private key, "cert" is the filename of the certificate. If the private key is encrypted, the "passphrase" parameter will be used to decrypt it.

Configuration File

When starting up, "Net::EPP::Simple" will look for "$HOME/.net-epp-simple-rc". This file is an ini-style configuration file.

Default Options

You can specify default options for all EPP servers using the "[default]" section:

        [default]
        default=epp.nic.tld
        debug=1

Server Specific Options

You can specify options for for specific EPP servers by giving each EPP server its own section:

        [epp.nic.tld]
        user=abc123
        pass=foo2bar
        port=777
        ssl=0

This means that when you write a script that uses "Net::EPP::Simple", you can do the following:

        # config file has a default server:
        my $epp = Net::EPP::Simple->new;

        # config file has connection options for this EPP server:
        my $epp = Net::EPP:Simple->new('host' => 'epp.nic.tld');

Any parameters provided to the constructor will override those in the config file.

Domain Information

        $info = {
          'contacts' => {
            'admin' => 'contact-id'
            'tech' => 'contact-id'
            'billing' => 'contact-id'
          },
          'registrant' => 'contact-id',
          'clID' => 'registrar-id',
          'roid' => 'tld-12345',
          'status' => [
            'ok'
          ],
          'authInfo' => 'abc-12345',
          'name' => 'example.tld',
          'trDate' => '2011-01-18T11:08:03.0Z',
          'ns' => [
            'ns0.example.com',
            'ns1.example.com',
          ],
          'crDate' => '2011-02-16T12:06:31.0Z',
          'exDate' => '2011-02-16T12:06:31.0Z',
          'crID' => 'registrar-id',
          'upDate' => '2011-08-29T04:02:12.0Z',
          hosts => [
            'ns0.example.tld',
            'ns1.example.tld',
          ],
        };

Members of the "contacts" hash ref may be strings or, if there are multiple associations of the same type, an anonymous array of strings. If the server uses the "hostAttr" model instead of "hostObj", then the "ns" member will look like this:

        $info->{ns} = [
          {
            name => 'ns0.example.com',
            addrs => [
              type => 'v4',
              addr => '10.0.0.1',
            ],
          },
          {
            name => 'ns1.example.com',
            addrs => [
              type => 'v4',
              addr => '10.0.0.2',
            ],
          },
        ];

Note that there may be multiple members in the "addrs" section and that the "type" attribute is optional.

Host Information

        $info = {
          'crDate' => '2011-09-17T15:38:56.0Z',
          'clID' => 'registrar-id',
          'crID' => 'registrar-id',
          'roid' => 'tld-12345',
          'status' => [
            'linked',
            'serverDeleteProhibited',    
          ],
          'name' => 'ns0.example.tld',
          'addrs' => [
            {
              'version' => 'v4',
              'addr' => '10.0.0.1'
            }
          ]
        };

Note that hosts may have multiple addresses, and that "version" is optional.

Contact Information

        $VAR1 = {
          'id' => 'contact-id',
          'postalInfo' => {
            'int' => {
              'name' => 'John Doe',
              'org' => 'Example Inc.',
              'addr' => {
                'street' => [
                  '123 Example Dr.'
                  'Suite 100'
                ],
                'city' => 'Dulles',
                'sp' => 'VA',
                'pc' => '20116-6503'
                'cc' => 'US',
              }
            }
          },
          'clID' => 'registrar-id',
          'roid' => 'CNIC-HA321983',
          'status' => [
            'linked',
            'serverDeleteProhibited'
          ],
          'voice' => '+1.7035555555x1234',
          'fax' => '+1.7035555556',
          'email' => 'jdoe@example.com',
          'crDate' => '2011-09-23T03:51:29.0Z',
          'upDate' => '1999-11-30T00:00:00.0Z'
        };

There may be up to two members of the "postalInfo" hash, corresponding to the "int" and "loc" internationalised and localised types.

Creating New Domains

        my $domain = {
          'name' => 'example.tld',
          'period' => 2,
          'registrant' => 'contact-id',
          'contacts' => {
            'tech' => 'contact-id',
            'admin' => 'contact-id',
            'billing' => 'contact-id',
          },
          'status' => [
            'clientTransferProhibited',
          ],
          'ns' => {
            'ns0.example.com',
            'ns1.example.com',
          },
        };

        $epp->create_domain($domain);

The "period" key is assumed to be in years rather than months. "Net::EPP::Simple" assumes the registry uses the host object model rather than the host attribute model.

Creating Hosts

    my $host = {
        name  => 'ns1.example.tld',
        addrs => [
            { ip => '123.45.67.89', version => 'v4' },
            { ip => '98.76.54.32',  version => 'v4' },
        ],
    };
    $epp->create_host($host);

Updating Domains

The update info parameter may look like: $update_info = { name => $domain, chg => { registrant => $new_registrant_id, authInfo => $new_domain_password, }, add => { # DNS info with "hostObj" or "hostAttr" model, see create_domain() ns => [ ns1.example.com ns2.example.com ], contacts => { tech => 'contact-id', billing => 'contact-id', admin => 'contact-id', },

        # Status info, simple form:
        status => [ qw/ clientUpdateProhibited clientHold / ],

        # Status info may be in more detailed form:
        # status => {
        #    clientUpdateProbhibited  => 'Avoid accidental change',
        #    clientHold               => 'This domain is not delegated',
        # },
    },
    rem => {
        ns       => [ ... ],
        contacts => {
            tech    => 'old_tech_id',
            billing => 'old_billing_id',
            admin   => 'old_admin_id',
        },
        status => [ qw/ clientTransferProhibited ... / ],
    },
}

All fields except 'name' in $update_info hash are optional.

Updating Contacts

The $update_info for contacts may look like this:

$update_info = { id => $contact_id, add => { status => [ qw/ clientDeleteProhibited / ], # OR # status => { # clientDeleteProhibited => 'Avoid accidental removal', # }, }, rem => { status => [ qw/ clientUpdateProhibited / ], }, chg => { postalInfo => { int => { name => 'John Doe', org => 'Example Inc.', addr => { street => [ '123 Example Dr.' 'Suite 100' ], city => 'Dulles', sp => 'VA', pc => '20116-6503' cc => 'US', }, }, }, voice => '+1.7035555555x1234', fax => '+1.7035555556', email => 'jdoe@example.com', authInfo => 'new-contact-password', }, }

All fields except 'id' in $update_info hash are optional.

Updating Hosts

The $update_info for hosts may look like this:

$update_info = { name => 'ns1.example.com', add => { status => [ qw/ clientDeleteProhibited / ], # OR # status => { # clientDeleteProhibited => 'Avoid accidental removal', # },

        addrs  => [
            { ip => '123.45.67.89', version => 'v4' },
            { ip => '98.76.54.32',  version => 'v4' },
        ],
    },
    rem => {
        status => [ qw/ clientUpdateProhibited / ],
        addrs  => [
            { ip => '1.2.3.4', version => 'v4' },
            { ip => '5.6.7.8', version => 'v4' },
        ],
    },
    chg => {
        name => 'ns2.example.com',
    },
}

All fields except first 'name' in $update_info hash are optional.

The "request()" Method

The "get_frame()" Method

$Net::EPP::Simple::Error

$Net::EPP::Simple::Message

$Net::EPP::Simple::Code