1// Copyright 2019 Google LLC.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14//
15
16syntax = "proto3";
17
18package google.cloud.phishingprotection.v1beta1;
19
20import "google/api/annotations.proto";
21import "google/api/client.proto";
22import "google/api/field_behavior.proto";
23import "google/api/resource.proto";
24
25option csharp_namespace = "Google.Cloud.PhishingProtection.V1Beta1";
26option go_package = "cloud.google.com/go/phishingprotection/apiv1beta1/phishingprotectionpb;phishingprotectionpb";
27option java_multiple_files = true;
28option java_outer_classname = "PhishingProtectionProto";
29option java_package = "com.google.phishingprotection.v1beta1";
30option objc_class_prefix = "GCPP";
31option php_namespace = "Google\\Cloud\\PhishingProtection\\V1beta1";
32option ruby_package = "Google::Cloud::PhishingProtection::V1beta1";
33
34// Service to report phishing URIs.
35service PhishingProtectionServiceV1Beta1 {
36  option (google.api.default_host) = "phishingprotection.googleapis.com";
37  option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
38
39  // Reports a URI suspected of containing phishing content to be reviewed. Once
40  // the report review is complete, its result can be found in the Cloud
41  // Security Command Center findings dashboard for Phishing Protection. If the
42  // result verifies the existence of malicious phishing content, the site will
43  // be added the to [Google's Social Engineering
44  // lists](https://support.google.com/webmasters/answer/6350487/) in order to
45  // protect users that could get exposed to this threat in the future.
46  rpc ReportPhishing(ReportPhishingRequest) returns (ReportPhishingResponse) {
47    option (google.api.http) = {
48      post: "/v1beta1/{parent=projects/*}/phishing:report"
49      body: "*"
50    };
51    option (google.api.method_signature) = "parent,uri";
52  }
53}
54
55// The ReportPhishing request message.
56message ReportPhishingRequest {
57  // Required. The name of the project for which the report will be created,
58  // in the format "projects/{project_number}".
59  string parent = 1 [
60    (google.api.field_behavior) = REQUIRED,
61    (google.api.resource_reference) = {
62      type: "cloudresourcemanager.googleapis.com/Project"
63    }
64  ];
65
66  // Required. The URI that is being reported for phishing content to be analyzed.
67  string uri = 2 [(google.api.field_behavior) = REQUIRED];
68}
69
70// The ReportPhishing (empty) response message.
71message ReportPhishingResponse {
72
73}
74