#google #google-api #protocols

google-securitycenter1

与安全命令中心(协议 v1)交互的完整库

16 个稳定版本 (4 个主要版本)

5.0.5+20240622 2024 年 6 月 27 日
5.0.4+20240302 2024 年 3 月 5 日
5.0.3+20230123 2023 年 8 月 24 日
5.0.2+20230123 2023 年 3 月 16 日
1.0.10+20190628 2019 年 7 月 6 日

#2088 in 网络编程

Download history 79/week @ 2024-06-21 33/week @ 2024-06-28 3/week @ 2024-07-05

1,000 个月下载量
google-securitycenter1-cl… 中使用

MIT 许可证

3MB
34K SLoC

“google-securitycenter1”库允许访问 Google 安全命令中心(服务)的所有功能。

本文档是从 Security Command Center crate 版本 5.0.5+20240622 生成的,其中 20240622 是由 mako 代码生成器 v5.0.5 构建的 securitycenter:v1 架构的确切修订。

关于安全命令中心 v1 API 的所有其他信息都可以在 官方文档网站 上找到。

功能

从中心 枢纽 ... 简单地处理以下 资源...

本库的结构

API 被结构化为以下主要项目

  • 枢纽
    • 一个中央对象,用于维护状态并允许访问所有 活动
    • 创建 方法构建器,这些构建器反过来又允许访问单个 调用构建器
  • 资源
    • 可以应用于 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 永远不会在 活动 中直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都带有适用的特质,以进一步分类它们并简化浏览。

一般来说,您可以这样调用 活动

let r = hub.resource().activity(...).doit().await

或具体地 ...

let r = hub.folders().assets_group(...).doit().await
let r = hub.folders().assets_list(...).doit().await
let r = hub.folders().assets_update_security_marks(...).doit().await
let r = hub.folders().big_query_exports_create(...).doit().await
let r = hub.folders().big_query_exports_delete(...).doit().await
let r = hub.folders().big_query_exports_get(...).doit().await
let r = hub.folders().big_query_exports_list(...).doit().await
let r = hub.folders().big_query_exports_patch(...).doit().await
let r = hub.folders().event_threat_detection_settings_custom_modules_create(...).doit().await
let r = hub.folders().event_threat_detection_settings_custom_modules_delete(...).doit().await
let r = hub.folders().event_threat_detection_settings_custom_modules_get(...).doit().await
let r = hub.folders().event_threat_detection_settings_custom_modules_list(...).doit().await
let r = hub.folders().event_threat_detection_settings_custom_modules_list_descendant(...).doit().await
let r = hub.folders().event_threat_detection_settings_custom_modules_patch(...).doit().await
let r = hub.folders().event_threat_detection_settings_effective_custom_modules_get(...).doit().await
let r = hub.folders().event_threat_detection_settings_effective_custom_modules_list(...).doit().await
let r = hub.folders().event_threat_detection_settings_validate_custom_module(...).doit().await
let r = hub.folders().findings_bulk_mute(...).doit().await
let r = hub.folders().locations_mute_configs_create(...).doit().await
let r = hub.folders().locations_mute_configs_delete(...).doit().await
let r = hub.folders().locations_mute_configs_get(...).doit().await
let r = hub.folders().locations_mute_configs_list(...).doit().await
let r = hub.folders().locations_mute_configs_patch(...).doit().await
let r = hub.folders().mute_configs_create(...).doit().await
let r = hub.folders().mute_configs_delete(...).doit().await
let r = hub.folders().mute_configs_get(...).doit().await
let r = hub.folders().mute_configs_list(...).doit().await
let r = hub.folders().mute_configs_patch(...).doit().await
let r = hub.folders().notification_configs_create(...).doit().await
let r = hub.folders().notification_configs_delete(...).doit().await
let r = hub.folders().notification_configs_get(...).doit().await
let r = hub.folders().notification_configs_list(...).doit().await
let r = hub.folders().notification_configs_patch(...).doit().await
let r = hub.folders().security_health_analytics_settings_custom_modules_create(...).doit().await
let r = hub.folders().security_health_analytics_settings_custom_modules_delete(...).doit().await
let r = hub.folders().security_health_analytics_settings_custom_modules_get(...).doit().await
let r = hub.folders().security_health_analytics_settings_custom_modules_list(...).doit().await
let r = hub.folders().security_health_analytics_settings_custom_modules_list_descendant(...).doit().await
let r = hub.folders().security_health_analytics_settings_custom_modules_patch(...).doit().await
let r = hub.folders().security_health_analytics_settings_custom_modules_simulate(...).doit().await
let r = hub.folders().security_health_analytics_settings_effective_custom_modules_get(...).doit().await
let r = hub.folders().security_health_analytics_settings_effective_custom_modules_list(...).doit().await
let r = hub.folders().sources_findings_external_systems_patch(...).doit().await
let r = hub.folders().sources_findings_group(...).doit().await
let r = hub.folders().sources_findings_list(...).doit().await
let r = hub.folders().sources_findings_patch(...).doit().await
let r = hub.folders().sources_findings_set_mute(...).doit().await
let r = hub.folders().sources_findings_set_state(...).doit().await
let r = hub.folders().sources_findings_update_security_marks(...).doit().await
let r = hub.folders().sources_list(...).doit().await

资源(resource())和活动(activity(...))的调用创建了构建器。第二个调用处理Activities,支持配置即将进行的操作的各种方法(此处未显示)。它设计成所有必要的参数都必须立即指定(即(...)),而所有可选的则可以按需构建doit()方法执行与服务器的实际通信并返回相应的结果。

用法

设置你的项目

要使用这个库,你需要在你的Cargo.toml文件中添加以下行

[dependencies]
google-securitycenter1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_securitycenter1 as securitycenter1;
use securitycenter1::{Result, Error};
use std::default::Default;
use securitycenter1::{SecurityCommandCenter, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = SecurityCommandCenter::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.folders().assets_list("parent")
             .read_time(chrono::Utc::now())
             .page_token("magna")
             .page_size(-11)
             .order_by("ipsum")
             .filter("voluptua.")
             .field_mask(FieldMask::new::<&str>(&[]))
             .compare_duration(chrono::Duration::seconds(9827880))
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

处理错误

系统产生的所有错误都通过Result枚举作为doit()方法的返回值提供,或者作为可能的中间结果传递给Hub Delegate,或Authenticator Delegate

当代理处理错误或中间值时,它们有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

如果某个方法支持下载,你应该读取响应体,以获取媒体。如果这样的方法也支持Response Result,它将默认返回该值。你可以将其视为实际媒体的元数据。要触发媒体下载,你需要通过此调用设置构建器:.param("alt", "media")

支持上传的方法可以使用最多2种不同的协议:简单可恢复。每种协议的独特性由定制的doit(...)方法表示,分别命名为upload(...)upload_resumable(...)

定制和回调

你可以通过在最终调用doit()之前向Method Builder提供一个代理来更改doit()方法的调用方式。相应的方法将被调用以提供进度信息,并确定系统是否应在失败时重试。

delegate trait具有默认实现,允许你以最少的努力进行自定义。

服务器请求中的可选部分

本库提供的所有结构都旨在通过 编码解码 来使用 json。使用可选类型来表示部分请求和响应是有效的。大多数可选类型被认为是 Parts,这些部分可以通过名称识别,并将发送到服务器以指示请求或响应中所需的设置部分。

构建器参数

使用 方法构建器,您可以通过重复调用其方法来准备动作调用。这些方法始终只接受一个参数,以下陈述适用于此参数。

  • PODs 通过复制传递
  • 字符串作为 &str 传递
  • 请求值 被移动

参数将始终复制或克隆到构建器中,以确保它们与其原始生命周期独立。

Cargo 功能

  • utoipa - 添加对 utoipa 的支持,并在所有类型上派生 utoipa::ToSchema。您必须在 #[openapi(schemas(...))] 中导入和注册所需类型,否则生成的 openapi 规范将无效。

许可证

securitycenter1 库由 Sebastian Thiel 生成,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。

依赖关系

~12–23MB
~344K SLoC