Create the alias service and resource (#4276)

* Create the alias service and resource

* Add alias generated API files and tests
This commit is contained in:
Todd committed 2024-02-29 15:51:24 -08:00
1 parent e848e76b48
commit 92181e272a
24 files changed
+5814 -50

No files matched your search

@@ -0,0 +1,113 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
syntax = "proto3";
package controller.api.resources.aliases.v1;
import "controller/api/resources/scopes/v1/scope.proto";
import "controller/custom_options/v1/options.proto";
import "google/api/visibility.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resources/aliases;aliases";
// Alias contains all fields related to an Alias resource
message Alias {
// Output only. The ID of the Alias.
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
// The ID of the scope of which this Alias is a part.
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
// Output only. Scope information for this Alias.
resources.scopes.v1.ScopeInfo scope = 30;
// Optional user-set name for identification purposes.
google.protobuf.StringValue name = 40 [
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "name"
that: "Name"
}
]; // @gotags: `class:"public"`
// Optional user-set descripton for identification purposes.
google.protobuf.StringValue description = 50 [
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "description"
that: "Description"
}
]; // @gotags: `class:"public"`
// Output only. The time this resource was created.
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 80; // @gotags: `class:"public"`
// Required value of the alias. This is the value referenced by the user that
// is resolved to the destination id.
string value = 90 [
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "value"
that: "Value"
}
]; // @gotags: `class:"public"`
// destination_id is the id of the resource that this Alias points to.
google.protobuf.StringValue destination_id = 100 [
json_name = "destination_id",
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "destination_id"
that: "DestinationId"
}
]; // @gotags: `class:"public" eventstream:"observation"`
oneof attrs {
// The attributes that are applicable for the specific Alias type.
google.protobuf.Struct attributes = 110 [
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.subtype) = "default"
];
TargetAliasAttributes target_alias_attributes = 101 [
(google.api.field_visibility).restriction = "INTERNAL",
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.subtype) = "target"
];
}
// Output only. The available actions on this resource for this user.
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public"`
}
// Attributes associated only with Aliases with type "target".
message TargetAliasAttributes {
AuthorizeSessionArguments authorize_session_arguments = 1 [json_name = "authorize_session_arguments"]; // @gotags: `class:"public"`
}
message AuthorizeSessionArguments {
// host_id is the id of the host that the session will be authorized for.
// When specified authorizing a session using this alias will have the same
// effect of authorizing a session to the aliase's destination_id and passing
// in this value through the -host-id flag. If the host-id flag is also
// specified when calling authorize-session an error will be returned unless
// the provided host-id matches this value.
string host_id = 100 [
json_name = "login_name",
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "attributes.authorize_session_arguments.host_id"
that: "HostId"
}
]; // @gotags: `class:"public"`
}
@@ -0,0 +1,158 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
syntax = "proto3";
package controller.api.services.v1;
import "controller/api/resources/aliases/v1/alias.proto";
import "controller/custom_options/v1/options.proto";
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";
import "protoc-gen-openapiv2/options/annotations.proto";
option go_package = "github.com/hashicorp/boundary/internal/gen/controller/api/services;services";
option (custom_options.v1.domain) = "auth";
service AliasService {
// GetAlias returns a stored Alias if present. The provided request must
// include the id for the Alias be retrieved. If missing, malformed or
// referencing a non existing Alias an error is returned.
rpc GetAlias(GetAliasRequest) returns (GetAliasResponse) {
option (google.api.http) = {
get: "/v1/aliases/{id}"
response_body: "item"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Gets a single Alias."};
}
// ListAliases returns a list of stored Aliases which exist inside the
// provided Scope. The request must include the Scope id which
// contains the Aliases being listed. If missing or malformed an error
// is returned.
rpc ListAliases(ListAliasesRequest) returns (ListAliasesResponse) {
option (google.api.http) = {get: "/v1/aliases"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Lists all Aliases in a specific Scope."};
}
// CreateAlias creates and stores an Alias in boundary. The provided
// request must include the Scope ID in which the Alias will be
// created. If the Scope ID is missing, malformed, or references a non
// existing resource an error is returned. If a name or login_name is
// provided that is in use in another Alias in the same Scope an
// error is returned.
rpc CreateAlias(CreateAliasRequest) returns (CreateAliasResponse) {
option (google.api.http) = {
post: "/v1/aliases"
body: "item"
response_body: "item"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Creates a single Alias in the provided scope."};
}
// UpdateAlias updates an existing Alias in boundary. The provided Alias
// must not have any read only fields set. The update mask must be included in
// the request and contain at least 1 mutable field. To unset a field's value,
// include the field in the update mask and don't set it in the provided
// Alias. An error is returned if the Alias id is missing or references a
// non-existing resource. An error is also returned if the request attempts
// to update the name or login_name to one that is already in use in the
// containing Scope.
rpc UpdateAlias(UpdateAliasRequest) returns (UpdateAliasResponse) {
option (google.api.http) = {
patch: "/v1/aliases/{id}"
body: "item"
response_body: "item"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Updates an Alias."};
}
// DeleteAlias removes an Alias from Boundary. If the provided Alias Id
// is malformed or not provided an error is returned.
rpc DeleteAlias(DeleteAliasRequest) returns (DeleteAliasResponse) {
option (google.api.http) = {delete: "/v1/aliases/{id}"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Deletes an Alias."};
}
}
message GetAliasRequest {
string id = 1; // @gotags: `class:"public" eventstream:"observation"`
}
message GetAliasResponse {
resources.aliases.v1.Alias item = 1;
}
message ListAliasesRequest {
string scope_id = 1 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
bool recursive = 2; // @gotags: `class:"public"`
string filter = 30 [json_name = "filter"]; // @gotags: `class:"sensitive"`
// An opaque token used to continue an existing iteration or
// request updated items. If not specified, pagination
// will start from the beginning.
string list_token = 40 [json_name = "list_token"]; // @gotags: `class:"public"`
// The maximum size of a page in this iteration.
// If unset, the default page size configured will be used.
// If the page_size is greater than the default page configured,
// an error will be returned.
uint32 page_size = 50 [json_name = "page_size"]; // @gotags: `class:"public"`
}
message ListAliasesResponse {
repeated resources.aliases.v1.Alias items = 1;
// The type of response, either "delta" or "complete".
// Delta signifies that this is part of a paginated result
// or an update to a previously completed pagination.
// Complete signifies that it is the last page.
string response_type = 2 [json_name = "response_type"]; // @gotags: `class:"public"`
// An opaque token used to continue an existing pagination or
// request updated items. Use this token in the next list request
// to request the next page.
string list_token = 3 [json_name = "list_token"]; // @gotags: `class:"public"`
// The name of the field which the items are sorted by.
string sort_by = 4 [json_name = "sort_by"]; // @gotags: `class:"public"`
// The direction of the sort, either "asc" or "desc".
string sort_dir = 5 [json_name = "sort_dir"]; // @gotags: `class:"public"`
// A list of item IDs that have been removed since they were returned
// as part of a pagination. They should be dropped from any client cache.
// This may contain items that are not known to the cache, if they were
// created and deleted between listings.
repeated string removed_ids = 6 [json_name = "removed_ids"]; // @gotags: `class:"public"`
// An estimate at the total items available. This may change during pagination.
uint32 est_item_count = 7 [json_name = "est_item_count"]; // @gotags: `class:"public"`
}
message CreateAliasRequest {
resources.aliases.v1.Alias item = 1;
}
message CreateAliasResponse {
string uri = 1; // @gotags: `class:"public" eventstream:"observation"`
resources.aliases.v1.Alias item = 2;
}
message UpdateAliasRequest {
string id = 1; // @gotags: `class:"public" eventstream:"observation"`
resources.aliases.v1.Alias item = 2;
google.protobuf.FieldMask update_mask = 3 [json_name = "update_mask"];
}
message UpdateAliasResponse {
resources.aliases.v1.Alias item = 1;
}
message DeleteAliasRequest {
string id = 1; // @gotags: `class:"public" eventstream:"observation"`
}
message DeleteAliasResponse {}
@@ -110,4 +110,5 @@ enum ResourceType {
RESOURCE_TYPE_USER = 18;
RESOURCE_TYPE_WORKER = 19;
RESOURCE_TYPE_POLICY = 20;
RESOURCE_TYPE_ALIAS = 21;
}