Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: [recaptchaenterprise] add AddIpOverride RPC #5629

Merged
merged 2 commits into from
Aug 22, 2024
Merged

feat: [recaptchaenterprise] add AddIpOverride RPC #5629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bac3b9d
feat: add AddIpOverride RPC
gcf-owl-bot[bot] Aug 20, 2024
5042266
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/google-cloud-recaptchaenterprise/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/

| Sample | Source Code | Try it |
| --------------------------- | --------------------------------- | ------ |
| Recaptcha_enterprise_service.add_ip_override | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.add_ip_override.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.add_ip_override.js,packages/google-cloud-recaptchaenterprise/samples/README.md) |
| Recaptcha_enterprise_service.annotate_assessment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.annotate_assessment.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.annotate_assessment.js,packages/google-cloud-recaptchaenterprise/samples/README.md) |
| Recaptcha_enterprise_service.create_assessment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.create_assessment.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.create_assessment.js,packages/google-cloud-recaptchaenterprise/samples/README.md) |
| Recaptcha_enterprise_service.create_firewall_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.create_firewall_policy.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.create_firewall_policy.js,packages/google-cloud-recaptchaenterprise/samples/README.md) |
Expand Down
75 changes: 69 additions & 6 deletions ...-recaptchaenterprise/protos/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,18 @@ service RecaptchaEnterpriseService {
};
}

// Adds an IP override to a key. The following restrictions hold:
// * The maximum number of IP overrides per key is 100.
// * For any conflict (such as IP already exists or IP part of an existing
// IP range), an error will be returned.
rpc AddIpOverride(AddIpOverrideRequest) returns (AddIpOverrideResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/keys/*}:addIpOverride"
body: "*"
};
option (google.api.method_signature) = "name,ip_override_data";
}

// Get some aggregated metrics for a Key. This data can be used to build
// dashboards.
rpc GetMetrics(GetMetricsRequest) returns (Metrics) {
Expand Down Expand Up @@ -708,8 +720,7 @@ message Event {
[deprecated = true, (google.api.field_behavior) = OPTIONAL];

// Optional. Flag for a reCAPTCHA express request for an assessment without a
// token. If enabled, `site_key` must reference a SCORE key with WAF feature
// set to EXPRESS.
// token. If enabled, `site_key` must reference an Express site key.
bool express = 14 [(google.api.field_behavior) = OPTIONAL];

// Optional. The URI resource the user requested that triggered an assessment.
Expand Down Expand Up @@ -1388,11 +1399,11 @@ message MigrateKeyRequest {
// Optional. If true, skips the billing check.
// A reCAPTCHA Enterprise key or migrated key behaves differently than a
// reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see
// https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid
// https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid
// any disruption of your usage, we check that a billing account is present.
// If your usage of reCAPTCHA is under the free quota, you can safely skip the
// billing check and proceed with the migration. See
// https://cloud.google.com/recaptcha-enterprise/docs/billing-information.
// https://cloud.google.com/recaptcha/docs/billing-information.
bool skip_billing_check = 2 [(google.api.field_behavior) = OPTIONAL];
}

Expand Down Expand Up @@ -1475,10 +1486,13 @@ message Key {

// Settings for keys that can be used by iOS apps.
IOSKeySettings ios_settings = 5;

// Settings for keys that can be used by reCAPTCHA Express.
ExpressKeySettings express_settings = 11;
}

// Optional. See [Creating and managing labels]
// (https://cloud.google.com/recaptcha-enterprise/docs/labels).
// (https://cloud.google.com/recaptcha/docs/labels).
map<string, string> labels = 6 [(google.api.field_behavior) = OPTIONAL];

// Output only. The timestamp corresponding to the creation of this key.
Expand Down Expand Up @@ -1618,6 +1632,9 @@ message IOSKeySettings {
[(google.api.field_behavior) = OPTIONAL];
}

// Settings specific to keys that can be used for reCAPTCHA Express.
message ExpressKeySettings {}

// Contains fields that are required to perform Apple-specific integrity checks.
message AppleDeveloperId {
// Required. Input only. A private key (downloaded as a text file with a .p8
Expand Down Expand Up @@ -1919,6 +1936,24 @@ message SearchRelatedAccountGroupMembershipsResponse {
string next_page_token = 2;
}

// The AddIpOverride request message.
message AddIpOverrideRequest {
// Required. The name of the key to which the IP override is added, in the
// format `projects/{project}/keys/{key}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "recaptchaenterprise.googleapis.com/Key"
}
];

// Required. IP override added to the key.
IpOverrideData ip_override_data = 2 [(google.api.field_behavior) = REQUIRED];
}

// Response for AddIpOverride.
message AddIpOverrideResponse {}

// A membership in a group of related accounts.
message RelatedAccountGroupMembership {
option (google.api.resource) = {
Expand Down Expand Up @@ -1969,7 +2004,7 @@ message RelatedAccountGroup {
// Firewall).
message WafSettings {
// Supported WAF features. For more information, see
// https://cloud.google.com/recaptcha-enterprise/docs/usecase#comparison_of_features.
// https://cloud.google.com/recaptcha/docs/usecase#comparison_of_features.
enum WafFeature {
// Undefined feature.
WAF_FEATURE_UNSPECIFIED = 0;
Expand Down Expand Up @@ -2010,3 +2045,31 @@ message WafSettings {
// Required. The WAF feature for which this key is enabled.
WafFeature waf_feature = 2 [(google.api.field_behavior) = REQUIRED];
}

// Information about the IP or IP range override.
message IpOverrideData {
// Enum that represents the type of IP override.
enum OverrideType {
// Default override type that indicates this enum hasn't been specified.
OVERRIDE_TYPE_UNSPECIFIED = 0;

// Allowlist the IP address; i.e. give a `risk_analysis.score` of 0.9 for
// all valid assessments.
ALLOW = 1;
}

// Required. The IP address to override (can be IPv4, IPv6 or CIDR).
// The IP override must be a valid IPv4 or IPv6 address, or a CIDR range.
// The IP override must be a public IP address.
// Example of IPv4: 168.192.5.6
// Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B
// Example of IPv4 with CIDR: 168.192.5.0/24
// Example of IPv6 with CIDR: 2001:0DB8:1234::/48
string ip = 1 [
(google.api.field_info).format = IPV4_OR_IPV6,
(google.api.field_behavior) = REQUIRED
];

// Required. Describes the type of IP override.
OverrideType override_type = 3 [(google.api.field_behavior) = REQUIRED];
}
Loading
Loading