8个版本 (稳定)
5.0.5+20240617 | 2024年6月27日 |
---|---|
5.0.4+20240226 | 2024年3月5日 |
5.0.3+20230116 | 2023年8月23日 |
5.0.2+20230116 | 2023年3月16日 |
3.0.0+20220225 | 2022年3月8日 |
#902 in 身份验证
1MB
11K SLoC
该 google-firebaseappcheck1_beta
库允许访问Google Firebaseappcheck服务的所有功能。
此文档是从 Firebaseappcheck crate版本 5.0.5+20240617 生成的,其中 20240617 是由 mako 代码生成器 v5.0.5 构建的 firebaseappcheck:v1beta 模式的确切修订。
有关Firebaseappcheck v1_beta API的其他所有信息,请参阅官方文档网站。
功能
轻松从中央 中心 处理以下 资源...
- jwks
- 获取
- oauth客户端
- 交换应用证明断言,交换应用证明证明,交换调试令牌 和 生成应用证明挑战
- 项目
- apps app attest config batch get, apps app attest config get, apps app attest config patch, apps debug tokens create, apps debug tokens delete, apps debug tokens get, apps debug tokens list, apps debug tokens patch, apps device check config batch get, apps device check config get, apps device check config patch, apps exchange app attest assertion, apps exchange app attest attestation, apps exchange custom token, apps exchange debug token, apps exchange device check token, apps exchange play integrity token, apps exchange recaptcha enterprise token, apps exchange recaptcha token, apps exchange recaptcha v3 token, apps exchange safety net token, apps generate app attest challenge, apps generate play integrity challenge, apps play integrity config batch get, apps play integrity config get, apps play integrity config patch, apps recaptcha config batch get, apps recaptcha config get, apps recaptcha config patch, apps recaptcha enterprise config batch get, apps recaptcha enterprise config get, apps recaptcha enterprise config patch, apps recaptcha v3 config batch get, apps recaptcha v3 config get, apps recaptcha v3 config patch, apps safety net config batch get, apps safety net config get, apps safety net config patch, services batch update, services get, services list, services patch, services resource policies batch update, services resource policies create, services resource policies delete, services resource policies get, services resource policies list, services resource policies patch and verify app check token
本库结构
API结构如下主要项
所有 结构 都带有适用的特质,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或者具体地...
let r = hub.oauth_clients().exchange_app_attest_assertion(...).doit().await
let r = hub.oauth_clients().exchange_debug_token(...).doit().await
let r = hub.projects().apps_exchange_app_attest_assertion(...).doit().await
let r = hub.projects().apps_exchange_custom_token(...).doit().await
let r = hub.projects().apps_exchange_debug_token(...).doit().await
let r = hub.projects().apps_exchange_device_check_token(...).doit().await
let r = hub.projects().apps_exchange_play_integrity_token(...).doit().await
let r = hub.projects().apps_exchange_recaptcha_enterprise_token(...).doit().await
let r = hub.projects().apps_exchange_recaptcha_token(...).doit().await
let r = hub.projects().apps_exchange_recaptcha_v3_token(...).doit().await
let r = hub.projects().apps_exchange_safety_net_token(...).doit().await
资源(resource()
)和活动(activity(...)
)调用创建构建器。后者处理Activities
,支持配置即将进行的操作的各种方法(此处未显示)。它设计成必须立即指定所有必需的参数(即(...)
),而所有可选参数可以按需构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您会将以下行放入您的Cargo.toml
文件中
[dependencies]
google-firebaseappcheck1_beta = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_firebaseappcheck1_beta as firebaseappcheck1_beta;
use firebaseappcheck1_beta::api::GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest;
use firebaseappcheck1_beta::{Result, Error};
use std::default::Default;
use firebaseappcheck1_beta::{Firebaseappcheck, 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 = Firebaseappcheck::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest::default();
// 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.oauth_clients().exchange_app_attest_assertion(req, "app")
.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")
。
支持上传的方法可以使用最多两种不同的协议进行:简单和可恢复。每个的独特之处在于定制的doit(...)
方法,分别命名为upload(...)
和upload_resumable(...)
。
自定义和回调
您可以通过在调用最终的 doit()
方法之前,向 方法构建器 提供一个 委托 来更改 doit()
方法的调用方式。相应的函数将被调用以提供进度信息,并确定系统是否应在失败时重试。
委托特质 具有默认实现,允许您以最小的努力进行自定义。
服务器请求中的可选部分
此库提供的所有结构都是为了通过 json 进行 编码 和 解码 而设计的。使用可选参数表示部分请求和响应是有效的。大多数可选参数都是可识别的 部分,这些部分可以通过名称进行标识,并将发送到服务器以指示请求的设置部分或响应中所需的部分。
构建器参数
通过使用 方法构建器,您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受单个参数,以下陈述对它适用。
参数将始终被复制或克隆到构建器中,以使它们与其原始的生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入并注册所需类型,否则生成的openapi
规范将是无效的。
许可证
firebaseappcheck1_beta 库由 Sebastian Thiel 创建,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖项
~12–23MB
~343K SLoC