First commit

This commit is contained in:
perp 2024-05-24 03:52:36 +01:00
commit 08bc4ae348
20 changed files with 785 additions and 0 deletions

2
.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
/target
/examples

89
Cargo.lock generated Normal file
View File

@ -0,0 +1,89 @@
# This file is automatically @generated by Cargo.
# It is not intended for manual editing.
version = 3
[[package]]
name = "construct-models"
version = "0.1.0"
dependencies = [
"serde",
"serde_json",
]
[[package]]
name = "itoa"
version = "1.0.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b"
[[package]]
name = "proc-macro2"
version = "1.0.82"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8ad3d49ab951a01fbaafe34f2ec74122942fe18a3f9814c3268f1bb72042131b"
dependencies = [
"unicode-ident",
]
[[package]]
name = "quote"
version = "1.0.36"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0fa76aaf39101c457836aec0ce2316dbdc3ab723cdda1c6bd4e6ad4208acaca7"
dependencies = [
"proc-macro2",
]
[[package]]
name = "ryu"
version = "1.0.18"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f3cb5ba0dc43242ce17de99c180e96db90b235b8a9fdc9543c96d2209116bd9f"
[[package]]
name = "serde"
version = "1.0.201"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "780f1cebed1629e4753a1a38a3c72d30b97ec044f0aef68cb26650a3c5cf363c"
dependencies = [
"serde_derive",
]
[[package]]
name = "serde_derive"
version = "1.0.201"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c5e405930b9796f1c00bee880d03fc7e0bb4b9a11afc776885ffe84320da2865"
dependencies = [
"proc-macro2",
"quote",
"syn",
]
[[package]]
name = "serde_json"
version = "1.0.117"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "455182ea6142b14f93f4bc5320a2b31c1f266b66a4a5c858b013302a5d8cbfc3"
dependencies = [
"itoa",
"ryu",
"serde",
]
[[package]]
name = "syn"
version = "2.0.61"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c993ed8ccba56ae856363b1845da7266a7cb78e1d146c8a32d54b45a8b831fc9"
dependencies = [
"proc-macro2",
"quote",
"unicode-ident",
]
[[package]]
name = "unicode-ident"
version = "1.0.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"

10
Cargo.toml Normal file
View File

@ -0,0 +1,10 @@
[workspace]
resolver = "1"
members = ["construct-models"]
[workspace.package]
authors = ["perp"]
license = "Apache License 2.0"
repository = "https://git.tcp.direct/perp/construct"
description = "Censys API wrapper made in Rust"
keywords = ["censys", "censys-api", "construct"]

201
LICENSE Normal file
View File

@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# Construct
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
Construct is a Censys API wrapper made in Rust
# Work in progress
<!--
## Examples
```
cargo run --example basic <key>
cargo run --example proxy <key> <proxy>
```
-->
## License
##### Provided under the [Apache License 2.0](./LICENSE)
###### Developers are not responsible for any misuse

View File

@ -0,0 +1,12 @@
[package]
name = "construct-models"
version = "0.1.0"
edition = "2021"
authors.workspace = true
license.workspace = true
repository.workspace = true
keywords.workspace = true
[dependencies]
serde = { version = "1.0.201", features = ["derive"] }
serde_json = "1.0.117"

View File

@ -0,0 +1,21 @@
use serde::Deserialize;
/// Account response
///
/// <https://search.censys.io/api#/account/account>
#[derive(Debug, Deserialize)]
pub struct Account {
pub login: String,
pub email: String,
pub first_login: String,
pub last_login: String,
pub quota: Quota,
}
/// Quota response for [`Account`]
#[derive(Debug, Deserialize)]
pub struct Quota {
pub used: i16,
pub resets_at: String,
pub allowance: i16,
}

View File

@ -0,0 +1,32 @@
use serde::Deserialize;
use serde_json::Value;
mod series;
pub use series::*;
/// Data response
///
/// <https://search.censys.io/api#/data/getSeries>
#[derive(Debug, Deserialize)]
pub struct Data {
pub primary_series: PrimarySeries,
pub raw_series: Value,
}
/// Primary series response for [`Data`]
#[derive(Debug, Deserialize)]
pub struct PrimarySeries {
pub certificates: Certificates,
pub domains: Value,
pub ipv4: Value,
}
/// Certificates response for [`PrimarySeries`]
#[derive(Debug, Deserialize)]
pub struct Certificates {
pub id: String,
pub name: String,
pub description: String,
pub details_url: String,
pub latest_result: Value,
}

View File

@ -0,0 +1,30 @@
use serde::Deserialize;
mod result;
pub use result::*;
/// Series response
///
/// <https://search.censys.io/api#/data/viewSeries>
#[derive(Debug, Deserialize)]
pub struct Series {
pub id: String,
pub name: String,
pub description: String,
pub results: Results,
}
/// Results response for [`Series`]
#[derive(Debug, Deserialize)]
pub struct Results {
pub historical: Vec<Historical>,
pub latest: Historical,
}
/// Historical response for [`Results`]
#[derive(Debug, Deserialize)]
pub struct Historical {
pub id: String,
pub timestamp: String,
pub details_url: String,
}

View File

@ -0,0 +1,50 @@
use serde::Deserialize;
use serde_json::Value;
/// Result response
///
/// <https://search.censys.io/api#/data/viewResult>
#[derive(Debug, Deserialize)]
pub struct Result {
pub id: String,
pub timestamp: String,
pub files: Files,
}
/// Files response for [`Result`]
#[derive(Debug, Deserialize)]
pub struct Files {
#[serde(rename = "zmap-results")]
pub zmap_results: ZResults,
#[serde(rename = "zgrab-results")]
pub zgrab_results: ZResults,
}
/// Zmap/zgrab results response for [`Files`]
#[derive(Debug, Deserialize)]
pub struct ZResults {
pub file_type: String,
pub schema: Schema,
pub download_path: String,
pub sha256_fingerprint: String,
pub size: i16,
#[serde(rename = "additionalProp1")]
pub additionalprop1: Option<Value>,
#[serde(rename = "additionalProp2")]
pub additionalprop2: Option<Value>,
#[serde(rename = "additionalProp3")]
pub additionalprop3: Option<Value>,
}
/// Schema response for [`ZResults`]
#[derive(Debug, Deserialize)]
pub struct Schema {
pub timestamp: Option<Type>,
pub ip: Option<Type>,
}
/// Type response for [`Schema`]
#[derive(Debug, Deserialize)]
pub struct Type {
pub r#type: String,
}

View File

@ -0,0 +1,27 @@
use serde::Deserialize;
/// Aggregate response
///
/// <https://search.censys.io/api#/hosts/aggregateHosts>
#[derive(Debug, Deserialize)]
pub struct Aggregate {
pub result: Result,
}
/// Result response for [`Aggregate`]
#[derive(Debug, Deserialize)]
pub struct Result {
pub total: i64,
pub total_omitted: i64,
pub potential_deviation: i16,
pub buckets: Vec<Buckets>,
pub query: String,
pub field: String,
}
/// Buckets response for [`Result`]
#[derive(Debug, Deserialize)]
pub struct Buckets {
pub key: String,
pub count: i32,
}

View File

@ -0,0 +1,32 @@
use serde::Deserialize;
use super::Links;
/// Certificates response
///
/// <https://search.censys.io/api#/hosts/getCertsByHost>
#[derive(Debug, Deserialize)]
pub struct Certificates {
pub result: Result,
}
/// Result response for [`Certificates`]
#[derive(Debug, Deserialize)]
pub struct Result {
pub ip: String,
pub observations: Vec<Observation>,
pub links: Links,
}
/// Observation response for [`Result`]
#[derive(Debug, Deserialize)]
pub struct Observation {
pub fingerprint: String,
pub port: i32,
pub service_name: String,
pub transport_protocol: String,
pub first_observed_at: String,
pub last_observed_at: String,
pub first_updated_at: String,
pub last_updated_at: String,
}

View File

@ -0,0 +1,26 @@
use serde::Deserialize;
/// Comments response
///
/// <https://search.censys.io/api#/hosts/getCommentsByHost>
#[derive(Debug, Deserialize)]
pub struct Comments {
pub result: Result,
}
/// Result response for [`Comments`]
#[derive(Debug, Deserialize)]
pub struct Result {
pub ip: String,
pub comments: Vec<Comment>,
}
/// Comment resopnse for [`Result`]
#[derive(Debug, Deserialize)]
pub struct Comment {
pub id: String,
pub ip: String,
pub author_id: String,
pub contents: String,
pub created_at: String,
}

View File

@ -0,0 +1,25 @@
use serde::Deserialize;
use serde_json::Value;
/// Diff response
///
/// <https://search.censys.io/api#/hosts/viewHostDiff>
#[derive(Debug, Deserialize)]
pub struct Diff {
pub result: Result,
}
/// Result response for [`Diff`]
#[derive(Debug, Deserialize)]
pub struct Result {
pub a: Update,
pub b: Update,
pub patch: Value,
}
/// Update response for [`Result`]
#[derive(Debug, Deserialize)]
pub struct Update {
pub ip: String,
pub last_updated_at: String,
}

View File

@ -0,0 +1,133 @@
use serde::Deserialize;
use serde_json::Value;
mod aggregate;
mod certificates;
mod comments;
mod diff;
mod names;
mod search;
pub use aggregate::{Result as AggregateResult, *};
pub use certificates::{Result as CertificatesResult, *};
pub use comments::{Result as CommentsResult, *};
pub use diff::{Result as DiffResult, Update, *};
pub use names::{Result as NamesResult, *};
pub use search::{Result as SearchResult, Service as SearchService, *};
// Move comments to directory with post/get
/// Result response
#[derive(Debug, Deserialize)]
pub struct Result {
pub ip: String,
pub services: Vec<Service>,
pub location_updated_at: String,
pub location: Location,
pub autonomous_system_updated_at: String,
pub autonomous_system: AutonomousSystem,
pub operating_system: OperatingSystem,
pub last_updated_at: String,
}
/// Links response for [`CertificatesResult`] / [`NamesResult`] / [`SearchResult`]
#[derive(Debug, Deserialize)]
pub struct Links {
pub prev: Option<String>,
pub next: Option<String>,
}
/// Autonomous system response for [`Result`] / [`Hit`]
#[derive(Debug, Deserialize)]
pub struct AutonomousSystem {
pub asn: i128,
pub description: String,
pub bgp_prefix: String,
pub name: String,
pub country_code: String,
}
/// Location response for [`Result`] / [`Hit`]
#[derive(Debug, Deserialize)]
pub struct Location {
pub continent: String,
pub country: String,
pub country_code: String,
pub postal_code: String,
pub timezone: String,
pub coordinates: Coordinates,
pub registered_country: String,
pub registered_country_code: String,
}
/// Host response
///
/// <https://search.censys.io/api#/hosts/viewHost>
#[derive(Debug, Deserialize)]
pub struct Host {
pub result: Result,
}
/// Service for [`Result`]
#[derive(Debug, Deserialize)]
pub struct Service {
pub port: i32,
pub service_name: String,
pub transport_protocol: String,
pub extended_service_name: String,
pub dns: Option<Dns>,
pub http: Option<Http>,
pub certificate: Option<String>,
pub tls: Option<Value>,
}
/// Dns response for [`Service`]
#[derive(Debug, Deserialize)]
pub struct Dns {
pub server_type: String,
}
/// Http response for [`Service`]
#[derive(Debug, Deserialize)]
pub struct Http {
pub request: Request,
pub response: Response,
}
/// Request response for [`Http`]
#[derive(Debug, Deserialize)]
pub struct Request {
pub method: String,
pub uri: String,
pub headers: Value,
}
/// Response response for [`Http`]
#[derive(Debug, Deserialize)]
pub struct Response {
pub body: String,
pub protocol: String,
pub body_size: i128,
pub status_code: i16,
pub status_reason: String,
pub headers: Value,
pub html_tags: Vec<String>,
}
/// Coordinates response for [`Location`]
#[derive(Debug, Deserialize)]
pub struct Coordinates {
pub latitude: String,
pub longitude: String,
}
/// Operating system response for [`Result`]
#[derive(Debug, Deserialize)]
pub struct OperatingSystem {
pub product: String,
pub vendor: String,
pub version: String,
pub edition: String,
pub uniform_resource_identifier: String,
pub other: Value,
}

View File

@ -0,0 +1,18 @@
use serde::Deserialize;
use super::Links;
/// Names response
///
/// <https://search.censys.io/api#/hosts/viewHostNames>
#[derive(Debug, Deserialize)]
pub struct Names {
pub result: Result,
}
/// Result response for [`Names`]
#[derive(Debug, Deserialize)]
pub struct Result {
pub names: Vec<String>,
pub links: Links,
}

View File

@ -0,0 +1,38 @@
use serde::Deserialize;
use super::{AutonomousSystem, Links, Location};
/// Search response
///
/// <https://search.censys.io/api#/hosts/searchHosts>
#[derive(Debug, Deserialize)]
pub struct Search {
pub result: Result,
pub links: Links,
}
/// Result response for [`Search`]
#[derive(Debug, Deserialize)]
pub struct Result {
pub query: String,
pub total: i64,
pub hits: Vec<Hit>,
}
/// Hit response for [`Result`]
#[derive(Debug, Deserialize)]
pub struct Hit {
pub ip: String,
pub services: Vec<Service>,
pub location: Location,
pub autonomous_system: AutonomousSystem,
}
/// Service response for [`Hit`]
#[derive(Debug, Deserialize)]
pub struct Service {
pub port: i32,
pub service_name: String,
pub transport_protocol: String,
pub certificate: Option<String>,
}

View File

@ -0,0 +1,4 @@
pub mod account;
pub mod data;
pub mod hosts;
pub mod metadata;

View File

@ -0,0 +1,15 @@
use serde::Deserialize;
/// Hosts response
///
/// <https://search.censys.io/api#/metadata/getHostMetadata>
#[derive(Debug, Deserialize)]
pub struct Hosts {
pub result: Result,
}
/// Result response for [`Hosts`]
#[derive(Debug, Deserialize)]
pub struct Result {
pub services: Vec<String>,
}

View File

@ -0,0 +1,2 @@
mod hosts;
pub use hosts::*;