106 lines
3.1 KiB
Markdown
106 lines
3.1 KiB
Markdown
|
ICANN RDAP Client Library
|
|||
|
|
=========================
|
|||
|
|
|
|||
|
|
This is a client library for the Registration Data Access Protocol (RDAP) written and sponsored
|
|||
|
|
by the Internet Corporation for Assigned Names and Numbers [(ICANN)](https://www.icann.org).
|
|||
|
|
RDAP is standard of the [IETF](https://ietf.org/), and extensions
|
|||
|
|
to RDAP are a current work activity of the IETF's [REGEXT working group](https://datatracker.ietf.org/wg/regext/documents/).
|
|||
|
|
More information on ICANN's role in RDAP can be found [here](https://www.icann.org/rdap).
|
|||
|
|
General information on RDAP can be found [here](https://rdap.rcode3.com/).
|
|||
|
|
|
|||
|
|
Installation
|
|||
|
|
------------
|
|||
|
|
|
|||
|
|
Add the library to your Cargo.toml: `cargo add icann-rdap-client`
|
|||
|
|
|
|||
|
|
Also, add the commons library: `cargo add icann-rdap-common`.
|
|||
|
|
|
|||
|
|
Both [icann_rdap_common] and this crate can be compiled for WASM targets.
|
|||
|
|
|
|||
|
|
Usage
|
|||
|
|
-----
|
|||
|
|
|
|||
|
|
In RDAP, [bootstrapping](https://rdap.rcode3.com/bootstrapping/iana.html)
|
|||
|
|
is the process of finding the authoritative RDAP server to
|
|||
|
|
query using the IANA RDAP bootstrap files. To make a query using bootstrapping:
|
|||
|
|
|
|||
|
|
```rust,no_run
|
|||
|
|
use icann_rdap_client::prelude::*;
|
|||
|
|
use std::str::FromStr;
|
|||
|
|
use tokio::main;
|
|||
|
|
|
|||
|
|
#[tokio::main]
|
|||
|
|
async fn main() -> Result<(), RdapClientError> {
|
|||
|
|
|
|||
|
|
// create a query
|
|||
|
|
let query = QueryType::from_str("192.168.0.1")?;
|
|||
|
|
// or
|
|||
|
|
let query = QueryType::from_str("icann.org")?;
|
|||
|
|
|
|||
|
|
// create a client (from icann-rdap-common)
|
|||
|
|
let config = ClientConfig::default();
|
|||
|
|
// or let config = ClientConfig::builder().build();
|
|||
|
|
|
|||
|
|
let client = create_client(&config)?;
|
|||
|
|
|
|||
|
|
// ideally, keep store in same context as client
|
|||
|
|
let store = MemoryBootstrapStore::new();
|
|||
|
|
|
|||
|
|
// issue the RDAP query
|
|||
|
|
let response =
|
|||
|
|
rdap_bootstrapped_request(
|
|||
|
|
&query,
|
|||
|
|
&client,
|
|||
|
|
&store,
|
|||
|
|
|reg| eprintln!("fetching {reg:?}")
|
|||
|
|
).await?;
|
|||
|
|
|
|||
|
|
Ok(())
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
To specify a base URL:
|
|||
|
|
|
|||
|
|
```rust,no_run
|
|||
|
|
use icann_rdap_client::prelude::*;
|
|||
|
|
use std::str::FromStr;
|
|||
|
|
use tokio::main;
|
|||
|
|
|
|||
|
|
#[tokio::main]
|
|||
|
|
async fn main() -> Result<(), RdapClientError> {
|
|||
|
|
|
|||
|
|
// create a query
|
|||
|
|
let query = QueryType::from_str("192.168.0.1")?;
|
|||
|
|
// or
|
|||
|
|
let query = QueryType::from_str("icann.org")?;
|
|||
|
|
|
|||
|
|
// create a client (from icann-rdap-common)
|
|||
|
|
let config = ClientConfig::builder().build();
|
|||
|
|
// or let config = ClientConfig::default();
|
|||
|
|
|
|||
|
|
let client = create_client(&config)?;
|
|||
|
|
|
|||
|
|
// issue the RDAP query
|
|||
|
|
let base_url = "https://rdap-bootstrap.arin.net/bootstrap";
|
|||
|
|
let response = rdap_request(base_url, &query, &client).await?;
|
|||
|
|
|
|||
|
|
Ok(())
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
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.
|