8 个版本 (稳定)

5.0.5+20240605	2024 年 6 月 27 日
5.0.4+20240221	2024 年 3 月 5 日
5.0.3+20230105	2023 年 8 月 24 日
5.0.2+20230105	2023 年 3 月 16 日
3.0.0+20220209	2022 年 3 月 8 日

#2013 in 网页编程

每月 468 次下载
在 google-privateca1-cli 中使用

MIT 许可证

1MB
10K SLoC

google-privateca1 库允许访问 Google 证书颁发机构服务 的所有功能。

此文档是从 证书颁发机构服务 版本 5.0.5+20240605 生成的，其中 20240605 是由 mako 代码生成器 v5.0.5 构建的 privateca:v1 架构的确切修订。

有关 证书颁发机构服务 v1 API 的其他所有信息，请参阅官方文档网站。

特性

轻松从中心枢纽处理以下资源...

本库结构

API 结构如下主要项

枢纽
- 一个中心对象，用于维护状态并允许访问所有活动
- 创建 方法构建器，这些构建器反过来允许访问单个 调用构建器
资源
- 您可以将其应用于活动的主要类型
- 属性和部分的集合
- 部分
  - 属性集合
  - 从未在活动中直接使用
活动
- 应用于资源的操作

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

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

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

或具体...

let r = hub.projects().locations_ca_pools_certificate_authorities_certificate_revocation_lists_patch(...).doit().await
let r = hub.projects().locations_ca_pools_certificate_authorities_activate(...).doit().await
let r = hub.projects().locations_ca_pools_certificate_authorities_create(...).doit().await
let r = hub.projects().locations_ca_pools_certificate_authorities_delete(...).doit().await
let r = hub.projects().locations_ca_pools_certificate_authorities_disable(...).doit().await
let r = hub.projects().locations_ca_pools_certificate_authorities_enable(...).doit().await
let r = hub.projects().locations_ca_pools_certificate_authorities_patch(...).doit().await
let r = hub.projects().locations_ca_pools_certificate_authorities_undelete(...).doit().await
let r = hub.projects().locations_ca_pools_create(...).doit().await
let r = hub.projects().locations_ca_pools_delete(...).doit().await
let r = hub.projects().locations_ca_pools_patch(...).doit().await
let r = hub.projects().locations_certificate_templates_create(...).doit().await
let r = hub.projects().locations_certificate_templates_delete(...).doit().await
let r = hub.projects().locations_certificate_templates_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await

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

使用方法

设置您的项目

要使用此库，您需要将以下行放入您的 Cargo.toml 文件中

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_privateca1 as privateca1;
use privateca1::{Result, Error};
use std::default::Default;
use privateca1::{CertificateAuthorityService, 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 = CertificateAuthorityService::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.projects().locations_ca_pools_certificate_authorities_delete("name")
             .skip_grace_period(true)
             .request_id("voluptua.")
             .ignore_dependent_resources(false)
             .ignore_active_certificates(true)
             .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。

当代表处理错误或中间值时，它们可能会有机会指示系统重试。这使得系统可能对各种错误都有弹性。

上传和下载

如果方法支持下载，则应读取响应体以获取媒体，该响应体是 Result 的一部分。如果此方法还支持 Response Result，则默认返回该结果。您可以将其视为实际媒体的元数据。要触发媒体下载，您将不得不通过此调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用多达 2 种不同的协议：简单和 可恢复。每个的特点都由定制的 doit(...) 方法表示，分别命名为 upload(...) 和 upload_resumable(...)。

定制和回调

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

delegate trait 默认实现，允许您以最小的努力对其进行定制。

服务器请求中的可选部分

本库提供的所有结构都是为了能够通过编码和解码以 json 格式。使用可选参数来表示部分请求或响应是有效的。大多数可选参数都是部分，可以通过名称进行识别，这些部分将被发送到服务器，以指示请求的设置部分或响应中所需的部分。

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖项

~12–23MB
~346K SLoC