1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
// This file is @generated by prost-build.
/// Describes an API diff request.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ComputeThreatListDiffRequest {
/// The ThreatList to update.
#[prost(enumeration = "ThreatType", tag = "1")]
pub threat_type: i32,
/// The current version token of the client for the requested list (the
/// client version that was received from the last successful diff).
#[prost(bytes = "bytes", tag = "2")]
pub version_token: ::prost::bytes::Bytes,
/// Required. The constraints associated with this request.
#[prost(message, optional, tag = "3")]
pub constraints: ::core::option::Option<
compute_threat_list_diff_request::Constraints,
>,
}
/// Nested message and enum types in `ComputeThreatListDiffRequest`.
pub mod compute_threat_list_diff_request {
/// The constraints for this diff.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Constraints {
/// The maximum size in number of entries. The diff will not contain more
/// entries than this value. This should be a power of 2 between 2**10 and
/// 2**20. If zero, no diff size limit is set.
#[prost(int32, tag = "1")]
pub max_diff_entries: i32,
/// Sets the maximum number of entries that the client is willing to have
/// in the local database. This should be a power of 2 between 2**10 and
/// 2**20. If zero, no database size limit is set.
#[prost(int32, tag = "2")]
pub max_database_entries: i32,
/// The compression types supported by the client.
#[prost(enumeration = "super::CompressionType", repeated, tag = "3")]
pub supported_compressions: ::prost::alloc::vec::Vec<i32>,
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ComputeThreatListDiffResponse {
/// The type of response. This may indicate that an action must be taken by the
/// client when the response is received.
#[prost(enumeration = "compute_threat_list_diff_response::ResponseType", tag = "4")]
pub response_type: i32,
/// A set of entries to add to a local threat type's list.
#[prost(message, optional, tag = "5")]
pub additions: ::core::option::Option<ThreatEntryAdditions>,
/// A set of entries to remove from a local threat type's list.
/// This field may be empty.
#[prost(message, optional, tag = "6")]
pub removals: ::core::option::Option<ThreatEntryRemovals>,
/// The new opaque client version token.
#[prost(bytes = "bytes", tag = "7")]
pub new_version_token: ::prost::bytes::Bytes,
/// The expected SHA256 hash of the client state; that is, of the sorted list
/// of all hashes present in the database after applying the provided diff.
/// If the client state doesn't match the expected state, the client must
/// disregard this diff and retry later.
#[prost(message, optional, tag = "8")]
pub checksum: ::core::option::Option<compute_threat_list_diff_response::Checksum>,
/// The soonest the client should wait before issuing any diff
/// request. Querying sooner is unlikely to produce a meaningful diff.
/// Waiting longer is acceptable considering the use case.
/// If this field is not set clients may update as soon as they want.
#[prost(message, optional, tag = "2")]
pub recommended_next_diff: ::core::option::Option<::prost_types::Timestamp>,
}
/// Nested message and enum types in `ComputeThreatListDiffResponse`.
pub mod compute_threat_list_diff_response {
/// The expected state of a client's local database.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Checksum {
/// The SHA256 hash of the client state; that is, of the sorted list of all
/// hashes present in the database.
#[prost(bytes = "bytes", tag = "1")]
pub sha256: ::prost::bytes::Bytes,
}
/// The type of response sent to the client.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ResponseType {
/// Unknown.
Unspecified = 0,
/// Partial updates are applied to the client's existing local database.
Diff = 1,
/// Full updates resets the client's entire local database. This means
/// that either the client had no state, was seriously out-of-date,
/// or the client is believed to be corrupt.
Reset = 2,
}
impl ResponseType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ResponseType::Unspecified => "RESPONSE_TYPE_UNSPECIFIED",
ResponseType::Diff => "DIFF",
ResponseType::Reset => "RESET",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"RESPONSE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"DIFF" => Some(Self::Diff),
"RESET" => Some(Self::Reset),
_ => None,
}
}
}
}
/// Request to check URI entries against threatLists.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchUrisRequest {
/// Required. The URI to be checked for matches.
#[prost(string, tag = "1")]
pub uri: ::prost::alloc::string::String,
/// Required. The ThreatLists to search in.
#[prost(enumeration = "ThreatType", repeated, packed = "false", tag = "2")]
pub threat_types: ::prost::alloc::vec::Vec<i32>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchUrisResponse {
/// The threat list matches. This may be empty if the URI is on no list.
#[prost(message, optional, tag = "1")]
pub threat: ::core::option::Option<search_uris_response::ThreatUri>,
}
/// Nested message and enum types in `SearchUrisResponse`.
pub mod search_uris_response {
/// Contains threat information on a matching uri.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ThreatUri {
/// The ThreatList this threat belongs to.
#[prost(enumeration = "super::ThreatType", repeated, tag = "1")]
pub threat_types: ::prost::alloc::vec::Vec<i32>,
/// The cache lifetime for the returned match. Clients must not cache this
/// response past this timestamp to avoid false positives.
#[prost(message, optional, tag = "2")]
pub expire_time: ::core::option::Option<::prost_types::Timestamp>,
}
}
/// Request to return full hashes matched by the provided hash prefixes.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchHashesRequest {
/// A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
/// hash. For JSON requests, this field is base64-encoded.
#[prost(bytes = "bytes", tag = "1")]
pub hash_prefix: ::prost::bytes::Bytes,
/// Required. The ThreatLists to search in.
#[prost(enumeration = "ThreatType", repeated, packed = "false", tag = "2")]
pub threat_types: ::prost::alloc::vec::Vec<i32>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchHashesResponse {
/// The full hashes that matched the requested prefixes.
/// The hash will be populated in the key.
#[prost(message, repeated, tag = "1")]
pub threats: ::prost::alloc::vec::Vec<search_hashes_response::ThreatHash>,
/// For requested entities that did not match the threat list, how long to
/// cache the response until.
#[prost(message, optional, tag = "2")]
pub negative_expire_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Nested message and enum types in `SearchHashesResponse`.
pub mod search_hashes_response {
/// Contains threat information on a matching hash.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ThreatHash {
/// The ThreatList this threat belongs to.
/// This must contain at least one entry.
#[prost(enumeration = "super::ThreatType", repeated, tag = "1")]
pub threat_types: ::prost::alloc::vec::Vec<i32>,
/// A 32 byte SHA256 hash. This field is in binary format. For JSON
/// requests, hashes are base64-encoded.
#[prost(bytes = "bytes", tag = "2")]
pub hash: ::prost::bytes::Bytes,
/// The cache lifetime for the returned match. Clients must not cache this
/// response past this timestamp to avoid false positives.
#[prost(message, optional, tag = "3")]
pub expire_time: ::core::option::Option<::prost_types::Timestamp>,
}
}
/// Contains the set of entries to add to a local database.
/// May contain a combination of compressed and raw data in a single response.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ThreatEntryAdditions {
/// The raw SHA256-formatted entries.
/// Repeated to allow returning sets of hashes with different prefix sizes.
#[prost(message, repeated, tag = "1")]
pub raw_hashes: ::prost::alloc::vec::Vec<RawHashes>,
/// The encoded 4-byte prefixes of SHA256-formatted entries, using a
/// Golomb-Rice encoding. The hashes are converted to uint32, sorted in
/// ascending order, then delta encoded and stored as encoded_data.
#[prost(message, optional, tag = "2")]
pub rice_hashes: ::core::option::Option<RiceDeltaEncoding>,
}
/// Contains the set of entries to remove from a local database.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ThreatEntryRemovals {
/// The raw removal indices for a local list.
#[prost(message, optional, tag = "1")]
pub raw_indices: ::core::option::Option<RawIndices>,
/// The encoded local, lexicographically-sorted list indices, using a
/// Golomb-Rice encoding. Used for sending compressed removal indices. The
/// removal indices (uint32) are sorted in ascending order, then delta encoded
/// and stored as encoded_data.
#[prost(message, optional, tag = "2")]
pub rice_indices: ::core::option::Option<RiceDeltaEncoding>,
}
/// A set of raw indices to remove from a local list.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RawIndices {
/// The indices to remove from a lexicographically-sorted local list.
#[prost(int32, repeated, tag = "1")]
pub indices: ::prost::alloc::vec::Vec<i32>,
}
/// The uncompressed threat entries in hash format.
/// Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4
/// bytes, but some hashes are lengthened if they collide with the hash of a
/// popular URI.
///
/// Used for sending ThreatEntryAdditons to clients that do not support
/// compression, or when sending non-4-byte hashes to clients that do support
/// compression.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RawHashes {
/// The number of bytes for each prefix encoded below. This field can be
/// anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).
#[prost(int32, tag = "1")]
pub prefix_size: i32,
/// The hashes, in binary format, concatenated into one long string. Hashes are
/// sorted in lexicographic order. For JSON API users, hashes are
/// base64-encoded.
#[prost(bytes = "bytes", tag = "2")]
pub raw_hashes: ::prost::bytes::Bytes,
}
/// The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or
/// compressed removal indices.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RiceDeltaEncoding {
/// The offset of the first entry in the encoded data, or, if only a single
/// integer was encoded, that single integer's value. If the field is empty or
/// missing, assume zero.
#[prost(int64, tag = "1")]
pub first_value: i64,
/// The Golomb-Rice parameter, which is a number between 2 and 28. This field
/// is missing (that is, zero) if `num_entries` is zero.
#[prost(int32, tag = "2")]
pub rice_parameter: i32,
/// The number of entries that are delta encoded in the encoded data. If only a
/// single integer was encoded, this will be zero and the single value will be
/// stored in `first_value`.
#[prost(int32, tag = "3")]
pub entry_count: i32,
/// The encoded deltas that are encoded using the Golomb-Rice coder.
#[prost(bytes = "bytes", tag = "4")]
pub encoded_data: ::prost::bytes::Bytes,
}
/// The type of threat. This maps dirrectly to the threat list a threat may
/// belong to.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum ThreatType {
/// Unknown.
Unspecified = 0,
/// Malware targeting any platform.
Malware = 1,
/// Social engineering targeting any platform.
SocialEngineering = 2,
/// Unwanted software targeting any platform.
UnwantedSoftware = 3,
}
impl ThreatType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ThreatType::Unspecified => "THREAT_TYPE_UNSPECIFIED",
ThreatType::Malware => "MALWARE",
ThreatType::SocialEngineering => "SOCIAL_ENGINEERING",
ThreatType::UnwantedSoftware => "UNWANTED_SOFTWARE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"THREAT_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"MALWARE" => Some(Self::Malware),
"SOCIAL_ENGINEERING" => Some(Self::SocialEngineering),
"UNWANTED_SOFTWARE" => Some(Self::UnwantedSoftware),
_ => None,
}
}
}
/// The ways in which threat entry sets can be compressed.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum CompressionType {
/// Unknown.
Unspecified = 0,
/// Raw, uncompressed data.
Raw = 1,
/// Rice-Golomb encoded data.
Rice = 2,
}
impl CompressionType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
CompressionType::Unspecified => "COMPRESSION_TYPE_UNSPECIFIED",
CompressionType::Raw => "RAW",
CompressionType::Rice => "RICE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"COMPRESSION_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"RAW" => Some(Self::Raw),
"RICE" => Some(Self::Rice),
_ => None,
}
}
}
/// Generated client implementations.
pub mod web_risk_service_v1_beta1_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Web Risk v1beta1 API defines an interface to detect malicious URLs on your
/// website and in client applications.
#[derive(Debug, Clone)]
pub struct WebRiskServiceV1Beta1Client<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> WebRiskServiceV1Beta1Client<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> WebRiskServiceV1Beta1Client<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
WebRiskServiceV1Beta1Client::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Gets the most recent threat list diffs.
pub async fn compute_threat_list_diff(
&mut self,
request: impl tonic::IntoRequest<super::ComputeThreatListDiffRequest>,
) -> std::result::Result<
tonic::Response<super::ComputeThreatListDiffResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.webrisk.v1beta1.WebRiskServiceV1Beta1/ComputeThreatListDiff",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.webrisk.v1beta1.WebRiskServiceV1Beta1",
"ComputeThreatListDiff",
),
);
self.inner.unary(req, path, codec).await
}
/// This method is used to check whether a URI is on a given threatList.
pub async fn search_uris(
&mut self,
request: impl tonic::IntoRequest<super::SearchUrisRequest>,
) -> std::result::Result<
tonic::Response<super::SearchUrisResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.webrisk.v1beta1.WebRiskServiceV1Beta1/SearchUris",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.webrisk.v1beta1.WebRiskServiceV1Beta1",
"SearchUris",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets the full hashes that match the requested hash prefix.
/// This is used after a hash prefix is looked up in a threatList
/// and there is a match. The client side threatList only holds partial hashes
/// so the client must query this method to determine if there is a full
/// hash match of a threat.
pub async fn search_hashes(
&mut self,
request: impl tonic::IntoRequest<super::SearchHashesRequest>,
) -> std::result::Result<
tonic::Response<super::SearchHashesResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.webrisk.v1beta1.WebRiskServiceV1Beta1/SearchHashes",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.webrisk.v1beta1.WebRiskServiceV1Beta1",
"SearchHashes",
),
);
self.inner.unary(req, path, codec).await
}
}
}