Crate icann_rdap_common

Expand description

§ICANN RDAP Common

This is a common component library for the Registration Data Access Protocol (RDAP) written and sponsored by the Internet Corporation for Assigned Names and Numbers (ICANN). RDAP is standard of the IETF, and extensions to RDAP are a current work activity of the IETF’s REGEXT working group. More information on ICANN’s role in RDAP can be found here. General information on RDAP can be found here.

§Installation

Add the library to your Cargo.toml: cargo add icann-rdap-common.

This library can be compiled for WASM targets.

§Usage

Parse RDAP JSON:

use icann_rdap_common::prelude::*;

let json = r#"
  {
    "objectClassName": "ip network",
    "links": [
      {
        "value": "http://localhost:3000/rdap/ip/10.0.0.0/16",
        "rel": "self",
        "href": "http://localhost:3000/rdap/ip/10.0.0.0/16",
        "type": "application/rdap+json"
      }
    ],
    "events": [
      {
        "eventAction": "registration",
        "eventDate": "2023-06-16T22:56:49.594173356+00:00"
      },
      {
        "eventAction": "last changed",
        "eventDate": "2023-06-16T22:56:49.594189140+00:00"
      }
    ],
    "startAddress": "10.0.0.0",
    "endAddress": "10.0.255.255",
    "ipVersion": "v4"
  }
"#;

let rdap: RdapResponse = serde_json::from_str(json).unwrap();
assert!(matches!(rdap, RdapResponse::Network(_)));

Create some RDAP objects:

use icann_rdap_common::prelude::*;

// create a simple entity to be used inside other objects with builder().
let holder = Entity::builder().handle("foo-BAR").build();

// create an RDAP domain response object with response_obj()
let domain = Domain::response_obj()
  .ldh_name("example.com")
  .extension(ExtensionId::IcannRdapResponseProfile1.as_ref())
  .extension(ExtensionId::IcannRdapTechnicalImplementationGuide1.as_ref())
  .notice(Notice::builder()
    .title("Inaccuracy resport")
    .description_entry("Things may be wrong. But it isn't our fault.")
    .description_entry("Read the policy for more information.")
    .build()
  )
  .entity(holder.clone())
  .build();

// create an IP network to be used as a response with response_obj()
let net = Network::response_obj()
  .cidr("10.0.0.0/16")
  .entity(holder.clone())
  .extension(ExtensionId::NroRdapProfile0.as_ref())
  .notice(Notice::builder().title("test").build())
  .build()
  .unwrap();

// create a nameserver for a response
let ns = Nameserver::response_obj()
  .ldh_name("ns1.example.com")
  .entity(holder.clone())
  .extension(ExtensionId::IcannRdapResponseProfile1.as_ref())
  .extension(ExtensionId::IcannRdapTechnicalImplementationGuide1.as_ref())
  .notice(Notice::builder().title("Inaccuracy resport").build())
  .build()
  .unwrap();

// create an autnum for a response
let autnum = Autnum::response_obj()
  .autnum_range(700..700)
  .entity(holder)
  .extension(ExtensionId::NroRdapProfile0.as_ref())
  .notice(Notice::builder().title("test").build())
  .build();

RDAP uses jCard, the JSON version of vCard, to model “contact information” (e.g. postal addresses, phone numbers, etc…). Because jCard is difficult to use and there might be other contact models standardized by the IETF, this library includes the contact::Contact struct. This struct can be converted to and from jCard/vCard with the contact::Contact::from_vcard and contact::Contact::to_vcard functions.

contact::Contact structs can be built using the builder.

use icann_rdap_common::contact::Contact;

let contact = Contact::builder()
  .kind("individual")
  .full_name("Bob Smurd")
  .build();

Once built, a Contact struct can be converted to an array of serde_json::Value’s, which can be used with serde to serialize to JSON.

use icann_rdap_common::contact::Contact;
use serde::Serialize;
use serde_json::Value;

let contact = Contact::builder()
  .kind("individual")
  .full_name("Bob Smurd")
  .build();

let v = contact.to_vcard();
let json = serde_json::to_string(&v);

To deserialize, use the from_vcard function.

use icann_rdap_common::contact::Contact;
use serde::Deserialize;
use serde_json::Value;

let json = r#"
[
  "vcard",
  [
    ["version", {}, "text", "4.0"],
    ["fn", {}, "text", "Joe User"],
    ["kind", {}, "text", "individual"],
    ["org", {
      "type":"work"
    }, "text", "Example"],
    ["title", {}, "text", "Research Scientist"],
    ["role", {}, "text", "Project Lead"],
    ["adr",
      { "type":"work" },
      "text",
      [
        "",
        "Suite 1234",
        "4321 Rue Somewhere",
        "Quebec",
        "QC",
        "G1V 2M2",
        "Canada"
      ]
    ],
    ["tel",
      { "type":["work", "voice"], "pref":"1" },
      "uri", "tel:+1-555-555-1234;ext=102"
    ],
    ["email",
      { "type":"work" },
      "text", "joe.user@example.com"
    ]
  ]
]"#;

let data: Vec<Value> = serde_json::from_str(json).unwrap();
let contact = Contact::from_vcard(&data);

§License

Licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) at your option.

§Contribution

Unless you explicitly state otherwise, any contribution, as defined in the Apache-2.0 license, intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed pursuant to the Apache License, Version 2.0 or the MIT License referenced as above, at ICANN’s option, without any additional terms or conditions.

Modules§

check: Conformance checks of RDAP structures.
contact: Easy representation of contact information found in an Entity.
dns_types: DNS and DNSSEC types.
httpdata: Code for handling HTTP caching.
iana: The IANA RDAP Bootstrap Registries.
media_types: RDAP media types (formerly known as mime types).
prelude: Basics RDAP structures.
response: RDAP structures for parsing and creating RDAP responses.

Constants§

VERSION: Version of this software.