@tdxvolt/volt-client-grpc 0.18.3 → 0.18.5

package/protobuf/tdx/volt_api/volt/v1/volt.proto

@@ -1,666 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.volt.v1;
-
-enum DiscoveryMode {
-  DISCOVERY_MODE_UNKNOWN = 0;
-
-  // Only local identities with explicit policy PERMIT can discover.
-  DISCOVERY_MODE_TRUSTED = 1;
-
-  // Any bound local identity can discover.
-  DISCOVERY_MODE_PUBLIC = 2;
-
-  // Only identities with explicit policy PERMIT can discover, and the service will be available to local and non-local (Relayed) clients.
-  DISCOVERY_MODE_TRUSTED_GLOBAL = 3;
-
-  // Any bound identity can discover, and the service will be available to local and non-local (Relayed) clients.
-  DISCOVERY_MODE_PUBLIC_GLOBAL = 4;
-}
-
-enum OnlineStatus {
-  ONLINE_STATUS_UNKNOWN = 0;
-  ONLINE_STATUS_ONLINE = 1;
-  ONLINE_STATUS_OFFLINE = 2;
-}
-
-// Not used ATM.
-enum ResourceStatus {
-  RESOURCE_STATUS_UNKNOWN = 0;
-  RESOURCE_STATUS_LIVE = 1;
-  RESOURCE_STATUS_INACTIVE = 2;
-  RESOURCE_STATUS_DELETED = 999;
-}
-
-// Not used ATM.
-enum ShareMode {
-  SHARE_MODE_UNKNOWN = 0;
-  SHARE_MODE_TRUSTED = 1;
-  SHARE_MODE_PUBLIC_READ = 2;
-}
-
-// @todo currently this must align with AuthorisationDecision enum in policy library, but some of the values are irrelevant outside of the public API so we need a public-facing enum and some translation.
-enum PolicyDecision {
-  POLICY_DECISION_UNKNOWN = 0;
-  POLICY_DECISION_PROMPT = 1;
-  POLICY_DECISION_PERMIT = 2;
-  POLICY_DECISION_DENY = 3;
-  POLICY_DECISION_INDETERMINATE = 4;
-  POLICY_DECISION_NOT_APPLICABLE = 5;
-  POLICY_DECISION_APPLICABLE = 6;
-  POLICY_DECISION_PENDING = 7;
-}
-
-// Attribute data types.
-enum AttributeDataType {
-  ATTRIBUTE_DATA_TYPE_UNKNOWN = 0;
-  ATTRIBUTE_DATA_TYPE_STRING = 1;
-  ATTRIBUTE_DATA_TYPE_INTEGER = 2;
-  ATTRIBUTE_DATA_TYPE_REAL = 3;
-  ATTRIBUTE_DATA_TYPE_BOOLEAN = 4;
-  ATTRIBUTE_DATA_TYPE_BYTES = 5;
-
-  ATTRIBUTE_DATA_TYPE_IDENTITY = 100;
-  ATTRIBUTE_DATA_TYPE_RESOURCE = 101;
-}
-
-// Represents an outbound connection from a Volt to a remote service that will act as a proxy for that Volt.
-// This enables Volts to bypass firewall and NATs.
-// Example - connection from a Volt to a Relay Volt running on the public internet, such as tdxvolt.com
-message ProxyConnection {
-  // Unique connection id.
-  string id = 1;
-
-  // A human-readable name for the connection.
-  string name = 2;
-
-  // The remote address of the proxy service.
-  string address = 3;
-
-  // The certificate authority of the proxy service.
-  string ca_pem = 4;
-
-  // Indicates this connection is enabled.
-  bool enabled = 5;
-
-  // Indicates this connection is currently in use.
-  bool connected = 6;
-
-  // Indicates that this connection will handle HTTP proxying as well as GRPC.
-  bool enable_http_proxy = 8;
-
-  // Set to indicate the Volt API itself is not automatically exposed to the connection.
-  bool disable_volt_api = 9;
-
-  // Optional challenge that can be presented in the authentication request.
-  string challenge = 10;
-
-  // The id of the target Volt that this connection is bound to.
-  string target_id = 11;
-
-  // Indicates that this connection hosts a DID registry that we should synchronise with.
-  bool sync_did_registry = 12;
-
-  // The id of the last DID registry operation that was synchronised.
-  uint64 did_registry_sync_id = 13;
-
-  // Indicates that this connection hosts a DID registry that we should synchronise with.
-  bool sync_vc_registry = 14;
-
-  // The timestamp of the last VC registry operation that was synchronised.
-  uint64 vc_registry_sync_timestamp = 15;
-
-  string session_id = 16;
-
-  string certificate = 17;
-}
-
-enum SecureMode {
-  SECURE_MODE_UNKNOWN = 0;
-  SECURE_MODE_INSECURE = 1;
-  SECURE_MODE_TLS = 2;
-}
-
-// Encapsulates the various Volt parameters that are configurable by the Volt owner.
-message VoltParameters {
-  string id = 1;
-
-  // The name of the Volt.
-  string name = 2;
-
-  // Human-readable description of the Volt.
-  string description = 3;
-
-  // The database driver in use.
-  string db_driver = 4;
-
-  // The local file path location of the Volt storage.
-  string location = 5;
-
-  // The key strategy in use, this determines how the root key is stored.
-  string key_strategy = 6;
-
-  // The identifier for the key, the semantics depend on the key strategy in use.
-  string key_id = 7;
-
-  // The Volt certificate authority.
-  string ca_pem = 8;
-
-  // The Volt API server certificate.
-  string cert_pem = 9;
-
-  // Optional hostname of the Volt if using DNS or a static IP address, e.g. tdxvolt.com
-  string fixed_host = 10;
-
-  // Port to use for hosting the Volt management service.
-  int32 grpc_port = 11;
-
-  // Port to use for hosting the Volt grpc service.
-  int32 http_port = 12;
-
-  // The Volt http server key file path.
-  string http_key_path = 13;
-
-  // The Volt http server certificate file path.
-  string http_cert_path = 14;
-
-  // The Volt http server certificate authority chain file path.
-  string http_ca_path = 15;
-
-  // Indicates the Volt will be discoverable by clients using the discovery api.
-  bool discoverable = 16;
-
-  // Optional challenge code that can be used aid in the process of authenticating clients.
-  string authenticate_challenge = 18;
-
-  // Indicates that clients must present the correct challenge code in order to be able to authenticate.
-  bool require_authenticate_challenge = 19;
-
-  // Internal use only.
-  bool confirm_stop = 20;
-
-  // Internal use only.
-  bool auto_start = 21;
-
-  // Internal use only.
-  bool enable_messaging = 22;
-
-  // Set to indicate this Volt acts as a Relay.
-  // This means this Volt can act as a proxy for other Volts (or in fact any client) that connect to it.
-  bool has_relay = 23;
-
-  // Set to run the Relay open to any client, i.e. clients can utilise the Relay without first authenticating.
-  bool relay_open = 24;
-
-  // Determines if the Volt HTTP server is enabled.
-  bool enable_http_server = 25;
-
-  // Determines whether the HTTP server employs TLS.
-  bool http_server_secure = 26;
-
-  // Determines whether the HTTP server supports forwarding.
-  bool enable_http_forwarding = 27;
-
-  // Determines if the Volt REST API is exposed via the HTTP server.
-  bool enable_http_api = 28;
-
-  // Determines if the Volt Websocket API is exposed via the HTTP server.
-  bool enable_websocket_api = 29;
-
-  // The hostname:port at which the Volt API is currently running.
-  string address = 30;
-
-  // Set to indicate the Volt file store is encrypted.
-  bool encrypt_file_store = 31;
-
-  // This is a unique connection id.
-  // Indicates that these parameters refer to a connection to a remote Volt rather than a local Volt.
-  string connection_id = 32;
-
-  // The certificate authority of the Relay if this is a remote connection via a Relay.
-  string relay_ca_pem = 33;
-
-  // Optional override of the http address, rather than using the default of fixed_host:http_port.
-  // This is useful if the Volt is behind a firewall or NAT, and the http server is listening on a different port
-  // from 80 or 443 but this is hidden by the proxy. For example, if the `fixed_host` is `coreid.com` and http server is
-  // listening on 2115, but the proxy is forwarding 443 to 2115, then the http_address_override would be set to
-  // `https://coreid.com`.
-  string http_address_override = 34;
-
-  // An optional alias that can be used to refer to the Volt rather than the `id` field.
-  // This alias must be unique within the scope of the Battery in which the Volt is stored.
-  string alias = 35;
-
-  // The runtime version this Volt is running.
-  Version version = 36;
-
-  // If set, indicates that any client that provides the correct challenge during authentication will automatically be approved to access the Volt.
-  bool approve_on_challenge = 37;
-
-  // If set, indicates that any client that proves ownership of a DID known to the Volt will automatically be approved to access the Volt.
-  bool approve_on_did = 38;
-
-  // If set, indicates that clients can register DIDs with this Volt.
-  bool enable_did_registry = 39;
-
-  // Zero or more URLs of trusted peer DID registries.
-  repeated string did_registry = 40;
-
-  // If set, enables outbound SMTP.
-  bool enable_outbound_smtp = 41;
-
-  // The SMTP host to use for sending emails.
-  string outbound_smtp_host = 42;
-
-  // The SMTP port to use for sending emails.
-  uint32 outbound_smtp_port = 43;
-
-  // The SMTP username to use for sending emails.
-  string outbound_smtp_user = 44;
-
-  // The SMTP password to use for sending emails.
-  string outbound_smtp_password = 45;
-
-  // If set, enables sessions that authenticate using credentials rather than a DID to create resources in the 'anonymous' system folder.
-  bool enable_anonymous_create = 46;
-
-  // The decision to apply to all authentication requests that do not match any other policy.
-  // The default is PROMPT.
-  PolicyDecision catch_all_auth_decision = 47;
-
-  // If set, enables caching of policy decisions.
-  bool enable_policy_cache = 48;
-
-  // If set, enables the terminal API.
-  bool enable_terminal = 49;
-
-  // The time at which the Volt was started.
-  uint64 start_time = 50;
-}
-
-message VoltEndpoint {
-  // The globally unique Volt id.
-  string id = 1;
-
-  // Human-readable name of the Volt.
-  string display_name = 3;
-
-  // The actual host/ip the volt is physically running on (might be a local ip if behind firewall).
-  string local_address = 4;
-
-  // The address of the endpoint HTTP server.
-  string http_address = 5;
-
-  // The global (Relay) address of the volt. Any given volt may be advertising on more than one Relay instance. The value given here will depend on the Relay instance that handled the endpoint query response.
-  string relay_address = 6;
-
-  // The root certificate of the Relay instance referred to in `relay_address`.
-  string relay_ca_pem = 7;
-
-  // The self-signed certificate used by the volt to sign client certificates.
-  string ca_pem = 8;
-
-  // The Volt public key in PEM format.
-  string public_key = 9;
-
-  // The base58 fingerprint of the Volt public key.
-  string fingerprint = 10;
-
-  // The online status of the Volt.
-  OnlineStatus online_status = 11;
-
-  // Indicates that this Volt acts as a Relay.
-  bool has_relay = 12;
-
-  // The API version supported by the endpoint.
-  Version api_version = 13;
-
-  // Optional description of the endpoint.
-  string description = 14;
-
-  // The list of DID registries that this Volt trusts.
-  repeated string did_registry = 15;
-}
-
-// Internal use only.
-message MethodDescription {
-  string path = 1;
-  bool client_streaming = 2;
-  bool server_streaming = 3;
-}
-
-// Describes a single protobuf file for use in ServiceDescription.
-message ProtoFile {
-  // The path name of the proto file, relative to the 'root' of the namespace, e.g. "tdx/volt_api/volt/v1/volt.proto".
-  string file_path = 1;
-
-  // The actual protobuf file contents.
-  string protobuf = 2;
-
-  // Optional - the service(s) contained in this protobuf file, if omitted here they will be loaded dynamically from the protobuf.
-  repeated string service_name = 3;
-}
-
-enum ServiceHostType {
-  SERVICE_HOST_TYPE_UNKNOWN = 0;
-  // A built-in service hosted by the Volt.
-  SERVICE_HOST_TYPE_BUILTIN = 1;
-  // A service hosted by a grpc server other than the Volt.
-  SERVICE_HOST_TYPE_SERVER = 2;
-  // A service hosted by a Volt client via a relay connection, i.e. the service is not exposed by a server as such, rather a Volt client implements the service and a Volt acts as a proxy, calling back to the client to implement the methods.
-  SERVICE_HOST_TYPE_RELAYED = 3;
-}
-
-// Describes a Volt service.
-message ServiceDescription {
-  // The configuration used by the host of this service.
-  ServiceHostType host_type = 1;
-
-  // The identity of the client that is exposing the service.
-  // For example, if a third party is exposing a database service via a Volt, it will first authenticate and obtain a client DID and credentials in order to be able to create service resource(s).
-  // Any resources that are owned by this client will be marked as online if the client itself is online, i.e. has a live connection to the Volt.
-  // This will be empty if the service is a built-in Volt service.
-  string host_client_id = 2;
-
-  // The id of the resource that holds the protobuf definition for this resource.
-  // For example, if a third party is exposing a database service via a Volt, it will create a service resource that holds details of the protobuf methods exposed by the service.
-  // For built-in services, i.e. those hosted by the Volt, this will set to the Volt id.
-  string host_service_id = 3;
-
-  // The address of the grpc server hosting this service.
-  // Only relevant to grpc-hosted services.
-  string host_address = 4;
-
-  // The certificate authority (chain) that signed the service server certificate.
-  // This is only relevant to grpc-hosted services.
-  string host_ca_pem = 5;
-
-  // The public key of the service host, which is used to encrypt payloads.
-  // This may change as the service comes and goes online.
-  string host_public_key = 6;
-
-  // The connection id currently used to host this service.
-  string host_connection_id = 8;
-
-  // Internal use only.
-  string host_session_id = 9;
-
-  // The discovery mode.
-  DiscoveryMode discoverable = 10;
-
-  // The ping timestamp of the server hosting this service.
-  int64 ping_timestamp = 11;
-
-  // The protobuf definitions of the APIs exposed by this service.
-  repeated ProtoFile proto_file = 12;
-
-  // The fully qualified names of the protobuf services, for example tdx.volt_api.webcam.v1.WebcamControlAPI.
-  repeated string service_api = 13;
-
-  // Internal use only.
-  repeated MethodDescription method = 100;
-}
-
-// Attribute value will be one of the following fields, depending on the data type.
-message AttributeValue {
-  oneof value {
-    string string = 1;
-    int64 integer = 2;
-    double real = 3;
-    bool boolean = 4;
-    bytes bytes = 5;
-  }
-}
-
-// A resource attribute enables storing arbitrary data associated with a resource.
-message ResourceAttribute {
-  uint32 id = 1;
-
-  string attribute_id = 2;
-
-  string resource_id = 3;
-
-  AttributeDataType data_type = 4;
-
-  repeated AttributeValue value = 5;
-}
-
-// Using `major` and `minor` here upsets the GNU C Library, so we add a `version_` prefix.
-message Version {
-  uint32 version_major = 1;
-  uint32 version_minor = 2;
-  uint32 version_patch = 3;
-}
-
-// The core Resource metadata schema.
-message Resource {
-  // The globally unique resource id.
-  string id = 1;
-
-  // Optional description.
-  string description = 2;
-
-  // Human-readable resource name.
-  string name = 4;
-
-  // Not in use.
-  ShareMode share_mode = 5;
-
-  // The id of the Volt that hosts this resource.
-  string volt_id = 7;
-
-  // Optional description of any services exposed by this resource.
-  ServiceDescription service_description = 8;
-
-  // Attributes assigned to the resource.
-  repeated ResourceAttribute attribute = 9;
-
-  // The version of the platform.
-  Version platform_version = 10;
-
-  // The resource version.
-  uint64 version = 11;
-
-  // The identity of the resource owner.
-  string owner = 101;
-
-  // Creation timestamp, milliseconds since epoch.
-  uint64 created = 105;
-
-  // Last modification timestamp, milliseconds since epoch.
-  uint64 modified = 106;
-
-  // Not in use.
-  ResourceStatus status = 108;
-
-  // The taxonomy of the resource.
-  repeated string kind = 110;
-
-  // The online status.
-  // For most kinds of resource this indicates that the server hosting the resource is online, the exception being identity resources, in which case the status reflects whether or not the identity has a live connection.
-  // All built-in resources are hosted by the Volt itself and are therefore always online when the Volt is running.
-  // Resources hosted by external servers are online if the server itself is online and has registered the resource as online using `setServiceStatus`.
-  OnlineStatus online_status = 111;
-
-  // The size of the resource store in bytes.
-  uint64 size = 113;
-
-  // The path to the resource store.
-  string store = 114;
-
-  // Alias(es) that can be used to refer to the resource rather than the id.
-  // Each alias must be unique to the Volt, this is enforced by the API.
-  // No format restrictions are currently applied to alias, but this may change in future, for the time being it makes sense to stick to alphanumeric characters and '_' or '-'.
-  repeated string alias = 115;
-
-  // The hash of the resource content contained in the store.
-  string content_hash = 116;
-
-  // Not yet supported.
-  repeated Resource child = 200;
-}
-
-message IdentityAlias {
-  // The alias id.
-  uint32 id = 1;
-
-  // The corresponding identity id.
-  string identity_did = 2;
-
-  // The actual alias, e.g. a common name or key fingerprint.
-  string alias = 3;
-
-  // This will only be populated if alias_type == tdx:public-key
-  string public_key = 4;
-
-  // This will only be populated if alias_type == tdx:public-key, and the key is stored in the Volt.
-  string private_key = 5;
-
-  // The alias type, for example public key, email, phone number etc.
-  string alias_type = 6;
-
-  // The identity that issued this alias.
-  string issuer_id = 7;
-
-  // Indicates if this alias has an authenticate policy decision assigned.
-  PolicyDecision authenticate = 8;
-
-  // Optional description of this alias.
-  string description = 9;
-}
-
-// A Volt identity encompasses a Resource and a set of identity aliases.
-message Identity {
-  Resource resource = 1;
-
-  repeated IdentityAlias alias = 2;
-}
-
-message Access {
-  string id = 1;
-
-  // The resource being accessed.
-  string resource_id = 2;
-
-  // A human-readable short identifier of the resource.
-  string resource_name = 3;
-
-  // The identity that owns the resource.
-  string resource_owner = 4;
-
-  // The kind of resource.
-  repeated string resource_kind = 5;
-
-  oneof subject {
-    // The identity attempting access.
-    string identity_did = 6;
-
-    // The JSON path array for looking up verifiable credentials.
-    string credential_lookup = 7;
-  }
-
-  // A human-readable short identifier of the subject.
-  string identity_name = 8;
-
-  // The kind of identity.
-  repeated string identity_kind = 9;
-
-  // Requested access.
-  string access = 10;
-
-  // Optional extra data.
-  string extra = 11;
-
-  // Assigned decision.
-  PolicyDecision decision = 12;
-
-  bool recursive = 13;
-
-  // Time at which the request was made.
-  int64 request_time = 14;
-
-  // Time at which the decision was taken.
-  int64 decision_time = 15;
-
-  // Counter of number times this access was requested.
-  uint32 request_count = 16;
-}
-
-enum SessionStatus {
-  SESSION_STATUS_UNKNOWN = 0;
-  SESSION_STATUS_PENDING = 1;
-  SESSION_STATUS_LIVE = 2;
-  SESSION_STATUS_EXPIRED = 3;
-  SESSION_STATUS_REVOKED = 4;
-  SESSION_STATUS_REJECTED = 5;
-}
-
-message SessionCredential {
-  // The alias id.
-  uint32 id = 1;
-
-  // The corresponding session id.
-  string session_id = 2;
-
-  // The credential type, for example public key, verifiable credential, challenge etc.
-  string credential_type = 4;
-
-  // Optional description of this credential.
-  string description = 5;
-
-  // The id of the verifiable credential, if the credential type is volt:vc-claim.
-  string vc_id = 6;
-
-  // The verifiable credential in JSON format, if the credential type is volt:vc-claim.
-  string vc_json = 7;
-
-  // The subject id extracted from the `vc_json` field.
-  string vc_subject_id = 8;
-
-  // The issuer id extracted from the `vc_json` field.
-  string vc_issuer_id = 9;
-
-  // The comma-separated type(s) extracted from the `vc_json` field.
-  string vc_type = 10;
-
-  // The challenge string, if the credential type is volt:challenge.
-  string challenge = 11;
-
-  // The key fingerprint, if the credential type is volt:public-key.
-  string key_fingerprint = 12;
-
-  // The PEM-encoded public key, if the credential type is volt:public-key.
-  string public_key = 13;
-
-  // Optional PEM-encoded private key, if the credential type is volt:public-key. Only used for ephemeral REST-base sessions created dynamically after OTP authentication.
-  string private_key = 14;
-
-  // Type-specific extra data stored with the credential.
-  string extra = 15;
-
-  // More type-specific data stored with the credential.
-  string extra_2 = 16;
-}
-
-message Session {
-  string id = 1;
-
-  string identity_did = 2;
-
-  string identity_name = 3;
-
-  string ip = 4;
-
-  uint64 created = 5;
-
-  uint64 modified = 6;
-
-  uint64 expires = 7;
-
-  repeated SessionCredential credential = 8;
-
-  string origin = 9;
-
-  SessionStatus status = 10;
-}
-