@leaflow/sdk 0.185.0 → 0.187.0

package/dist/proto/leaflow/fleet/privilege/v1/privilege_pb.d.ts

@@ -0,0 +1,569 @@
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file leaflow/fleet/privilege/v1/privilege.proto.
+ */
+export declare const file_leaflow_fleet_privilege_v1_privilege: GenFile;
+/**
+ * The request of DecidePrivilegeRequest.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.DecidePrivilegeRequestRequest
+ */
+export type DecidePrivilegeRequestRequest = Message<"leaflow.fleet.privilege.v1.DecidePrivilegeRequestRequest"> & {
+    /**
+     * The request, as the daemon shows it to participants.
+     *
+     * @generated from field: leaflow.fleet.privilege.v1.PrivilegeRequest request = 1;
+     */
+    request?: PrivilegeRequest | undefined;
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.DecidePrivilegeRequestRequest.
+ * Use `create(DecidePrivilegeRequestRequestSchema)` to create a new message.
+ */
+export declare const DecidePrivilegeRequestRequestSchema: GenMessage<DecidePrivilegeRequestRequest>;
+/**
+ * The response of DecidePrivilegeRequest.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.DecidePrivilegeRequestResponse
+ */
+export type DecidePrivilegeRequestResponse = Message<"leaflow.fleet.privilege.v1.DecidePrivilegeRequestResponse"> & {
+    /**
+     * APPROVED, DENIED or EXPIRED.
+     *
+     * @generated from field: leaflow.fleet.privilege.v1.PrivilegeOutcome outcome = 1;
+     */
+    outcome: PrivilegeOutcome;
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.DecidePrivilegeRequestResponse.
+ * Use `create(DecidePrivilegeRequestResponseSchema)` to create a new message.
+ */
+export declare const DecidePrivilegeRequestResponseSchema: GenMessage<DecidePrivilegeRequestResponse>;
+/**
+ * A message from the participant.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.ClientMessage
+ */
+export type ClientMessage = Message<"leaflow.fleet.privilege.v1.ClientMessage"> & {
+    /**
+     * The message.
+     *
+     * @generated from oneof leaflow.fleet.privilege.v1.ClientMessage.message
+     */
+    message: {
+        /**
+         * A person decided on a request.
+         *
+         * @generated from field: leaflow.fleet.privilege.v1.SignedPrivilegeDecision decision = 1;
+         */
+        value: SignedPrivilegeDecision;
+        case: "decision";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.ClientMessage.
+ * Use `create(ClientMessageSchema)` to create a new message.
+ */
+export declare const ClientMessageSchema: GenMessage<ClientMessage>;
+/**
+ * A message from the session.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.ServerMessage
+ */
+export type ServerMessage = Message<"leaflow.fleet.privilege.v1.ServerMessage"> & {
+    /**
+     * The message.
+     *
+     * @generated from oneof leaflow.fleet.privilege.v1.ServerMessage.message
+     */
+    message: {
+        /**
+         * What this participant may do. The first message.
+         *
+         * @generated from field: leaflow.fleet.privilege.v1.ServerHello server_hello = 1;
+         */
+        value: ServerHello;
+        case: "serverHello";
+    } | {
+        /**
+         * A request is pending.
+         *
+         * @generated from field: leaflow.fleet.privilege.v1.PrivilegePrompt prompt = 2;
+         */
+        value: PrivilegePrompt;
+        case: "prompt";
+    } | {
+        /**
+         * A request is no longer pending.
+         *
+         * @generated from field: leaflow.fleet.privilege.v1.PrivilegeRequestClosed request_closed = 3;
+         */
+        value: PrivilegeRequestClosed;
+        case: "requestClosed";
+    } | {
+        /**
+         * Ends the snapshot.
+         *
+         * @generated from field: leaflow.fleet.privilege.v1.SnapshotEnd snapshot_end = 4;
+         */
+        value: SnapshotEnd;
+        case: "snapshotEnd";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.ServerMessage.
+ * Use `create(ServerMessageSchema)` to create a new message.
+ */
+export declare const ServerMessageSchema: GenMessage<ServerMessage>;
+/**
+ * What this participant may do.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.ServerHello
+ */
+export type ServerHello = Message<"leaflow.fleet.privilege.v1.ServerHello"> & {
+    /**
+     * The participant's authorization allows it to approve requests. Without it
+     * the participant sees requests and cannot decide them.
+     *
+     * @generated from field: bool approve_allowed = 1;
+     */
+    approveAllowed: boolean;
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.ServerHello.
+ * Use `create(ServerHelloSchema)` to create a new message.
+ */
+export declare const ServerHelloSchema: GenMessage<ServerHello>;
+/**
+ * A pending request to show.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.PrivilegePrompt
+ */
+export type PrivilegePrompt = Message<"leaflow.fleet.privilege.v1.PrivilegePrompt"> & {
+    /**
+     * A serialized PrivilegeRequest, exactly as the daemon produced it. The
+     * participant shows the request decoded from these bytes and signs their
+     * SHA-256.
+     *
+     * @generated from field: bytes request = 1;
+     */
+    request: Uint8Array;
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.PrivilegePrompt.
+ * Use `create(PrivilegePromptSchema)` to create a new message.
+ */
+export declare const PrivilegePromptSchema: GenMessage<PrivilegePrompt>;
+/**
+ * A request for a privileged operation, serialized by the Agent's privileged
+ * daemon.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.PrivilegeRequest
+ */
+export type PrivilegeRequest = Message<"leaflow.fleet.privilege.v1.PrivilegeRequest"> & {
+    /**
+     * A UUID chosen by the daemon (RFC 9562).
+     *
+     * @generated from field: string request_id = 1;
+     */
+    requestId: string;
+    /**
+     * 32 random bytes chosen by the daemon.
+     *
+     * @generated from field: bytes nonce = 2;
+     */
+    nonce: Uint8Array;
+    /**
+     * The machine.
+     *
+     * @generated from field: string machine_id = 3;
+     */
+    machineId: string;
+    /**
+     * The session the asking process belongs to. Empty when it belongs to no
+     * session of the platform, such as after an SSH login.
+     *
+     * @generated from field: string session_id = 4;
+     */
+    sessionId: string;
+    /**
+     * When the request was made.
+     *
+     * @generated from field: google.protobuf.Timestamp created_at = 5;
+     */
+    createdAt?: Timestamp | undefined;
+    /**
+     * When the daemon stops waiting and the asking program fails or goes on
+     * to its next way of authenticating. Informational: the daemon times
+     * requests on its own monotonic clock.
+     *
+     * @generated from field: google.protobuf.Timestamp expires_at = 6;
+     */
+    expiresAt?: Timestamp | undefined;
+    /**
+     * Claim: the asking process, such as the sudo process, the subject of a
+     * polkit check or the application asking for the keyring. 0 when unknown.
+     *
+     * @generated from field: uint32 pid = 7;
+     */
+    pid: number;
+    /**
+     * Claim: the command line of pid, such as "sudo apt install foo".
+     *
+     * @generated from field: string command_line = 8;
+     */
+    commandLine: string;
+    /**
+     * What is to be approved.
+     *
+     * @generated from oneof leaflow.fleet.privilege.v1.PrivilegeRequest.operation
+     */
+    operation: {
+        /**
+         * Authentication by a PAM stack, for sudo or polkit.
+         *
+         * @generated from field: leaflow.fleet.privilege.v1.PamAuthentication pam_authentication = 9;
+         */
+        value: PamAuthentication;
+        case: "pamAuthentication";
+    } | {
+        /**
+         * Access to a collection of the user's keyring.
+         *
+         * @generated from field: leaflow.fleet.privilege.v1.KeyringAccess keyring_access = 10;
+         */
+        value: KeyringAccess;
+        case: "keyringAccess";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.PrivilegeRequest.
+ * Use `create(PrivilegeRequestSchema)` to create a new message.
+ */
+export declare const PrivilegeRequestSchema: GenMessage<PrivilegeRequest>;
+/**
+ * Authentication by a PAM stack (pam_start(3)), as sudo and polkit ask for
+ * it.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.PamAuthentication
+ */
+export type PamAuthentication = Message<"leaflow.fleet.privilege.v1.PamAuthentication"> & {
+    /**
+     * The PAM service that asks, such as "sudo" or "polkit-1".
+     *
+     * @generated from field: string service = 1;
+     */
+    service: string;
+    /**
+     * The account to authenticate as (PAM_USER).
+     *
+     * @generated from field: string username = 2;
+     */
+    username: string;
+    /**
+     * The user who asked, when PAM knows it (PAM_RUSER).
+     *
+     * @generated from field: string requesting_user = 3;
+     */
+    requestingUser: string;
+    /**
+     * The remote host, when PAM knows it (PAM_RHOST).
+     *
+     * @generated from field: string remote_host = 4;
+     */
+    remoteHost: string;
+    /**
+     * The terminal, when PAM knows it (PAM_TTY), such as "/dev/pts/3".
+     *
+     * @generated from field: string tty = 5;
+     */
+    tty: string;
+    /**
+     * Claim: the polkit action, such as "org.freedesktop.policykit.exec".
+     * Empty for sudo.
+     *
+     * @generated from field: string polkit_action_id = 6;
+     */
+    polkitActionId: string;
+    /**
+     * Claim: the localized message polkit asked to show. Empty for sudo.
+     *
+     * @generated from field: string message = 7;
+     */
+    message: string;
+    /**
+     * Claim: the localized polkit details, such as "program" and
+     * "command_line".
+     *
+     * @generated from field: map<string, string> details = 8;
+     */
+    details: {
+        [key: string]: string;
+    };
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.PamAuthentication.
+ * Use `create(PamAuthenticationSchema)` to create a new message.
+ */
+export declare const PamAuthenticationSchema: GenMessage<PamAuthentication>;
+/**
+ * Access to a collection of the user's keyring (freedesktop Secret Service
+ * API), which an application asked for and which the Secret Service would
+ * otherwise prompt for with a password.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.KeyringAccess
+ */
+export type KeyringAccess = Message<"leaflow.fleet.privilege.v1.KeyringAccess"> & {
+    /**
+     * What the application asked for.
+     *
+     * @generated from field: leaflow.fleet.privilege.v1.KeyringOperation operation = 1;
+     */
+    operation: KeyringOperation;
+    /**
+     * Claim: the label of the collection, such as "Login".
+     *
+     * @generated from field: string collection_label = 2;
+     */
+    collectionLabel: string;
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.KeyringAccess.
+ * Use `create(KeyringAccessSchema)` to create a new message.
+ */
+export declare const KeyringAccessSchema: GenMessage<KeyringAccess>;
+/**
+ * A person's decision, signed by the participant.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.SignedPrivilegeDecision
+ */
+export type SignedPrivilegeDecision = Message<"leaflow.fleet.privilege.v1.SignedPrivilegeDecision"> & {
+    /**
+     * A serialized PrivilegeDecision.
+     *
+     * @generated from field: bytes decision = 1;
+     */
+    decision: Uint8Array;
+    /**
+     * The Ed25519 signature (RFC 8032) over the ASCII bytes
+     * "leaflow.fleet.privilege.v1.PrivilegeDecision", one zero byte
+     * and decision, by the participant key of the connection's authorization.
+     *
+     * @generated from field: bytes signature = 2;
+     */
+    signature: Uint8Array;
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.SignedPrivilegeDecision.
+ * Use `create(SignedPrivilegeDecisionSchema)` to create a new message.
+ */
+export declare const SignedPrivilegeDecisionSchema: GenMessage<SignedPrivilegeDecision>;
+/**
+ * A person's decision on one request.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.PrivilegeDecision
+ */
+export type PrivilegeDecision = Message<"leaflow.fleet.privilege.v1.PrivilegeDecision"> & {
+    /**
+     * SHA-256 of PrivilegePrompt.request, 32 bytes.
+     *
+     * @generated from field: bytes request_sha256 = 1;
+     */
+    requestSha256: Uint8Array;
+    /**
+     * The person approved the request. False: denied.
+     *
+     * @generated from field: bool approved = 2;
+     */
+    approved: boolean;
+    /**
+     * When the person decided. Informational.
+     *
+     * @generated from field: google.protobuf.Timestamp decided_at = 3;
+     */
+    decidedAt?: Timestamp | undefined;
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.PrivilegeDecision.
+ * Use `create(PrivilegeDecisionSchema)` to create a new message.
+ */
+export declare const PrivilegeDecisionSchema: GenMessage<PrivilegeDecision>;
+/**
+ * A request is no longer pending.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.PrivilegeRequestClosed
+ */
+export type PrivilegeRequestClosed = Message<"leaflow.fleet.privilege.v1.PrivilegeRequestClosed"> & {
+    /**
+     * PrivilegeRequest.request_id.
+     *
+     * @generated from field: string request_id = 1;
+     */
+    requestId: string;
+    /**
+     * How it ended.
+     *
+     * @generated from field: leaflow.fleet.privilege.v1.PrivilegeOutcome outcome = 2;
+     */
+    outcome: PrivilegeOutcome;
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.PrivilegeRequestClosed.
+ * Use `create(PrivilegeRequestClosedSchema)` to create a new message.
+ */
+export declare const PrivilegeRequestClosedSchema: GenMessage<PrivilegeRequestClosed>;
+/**
+ * Ends the snapshot.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.SnapshotEnd
+ */
+export type SnapshotEnd = Message<"leaflow.fleet.privilege.v1.SnapshotEnd"> & {};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.SnapshotEnd.
+ * Use `create(SnapshotEndSchema)` to create a new message.
+ */
+export declare const SnapshotEndSchema: GenMessage<SnapshotEnd>;
+/**
+ * What a participant may do with privilege requests. Carried in the
+ * participant's signed authorization; the service grants approve_allowed only
+ * to the devices of the session's person.
+ *
+ * @generated from message leaflow.fleet.privilege.v1.PrivilegePolicy
+ */
+export type PrivilegePolicy = Message<"leaflow.fleet.privilege.v1.PrivilegePolicy"> & {
+    /**
+     * The participant may approve or deny requests.
+     *
+     * @generated from field: bool approve_allowed = 1;
+     */
+    approveAllowed: boolean;
+};
+/**
+ * Describes the message leaflow.fleet.privilege.v1.PrivilegePolicy.
+ * Use `create(PrivilegePolicySchema)` to create a new message.
+ */
+export declare const PrivilegePolicySchema: GenMessage<PrivilegePolicy>;
+/**
+ * An operation on the keyring that needs approval.
+ *
+ * @generated from enum leaflow.fleet.privilege.v1.KeyringOperation
+ */
+export declare enum KeyringOperation {
+    /**
+     * @generated from enum value: KEYRING_OPERATION_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Unlocking a collection (Service.Unlock).
+     *
+     * @generated from enum value: KEYRING_OPERATION_UNLOCK_COLLECTION = 1;
+     */
+    UNLOCK_COLLECTION = 1,
+    /**
+     * Creating a collection (Service.CreateCollection).
+     *
+     * @generated from enum value: KEYRING_OPERATION_CREATE_COLLECTION = 2;
+     */
+    CREATE_COLLECTION = 2
+}
+/**
+ * Describes the enum leaflow.fleet.privilege.v1.KeyringOperation.
+ */
+export declare const KeyringOperationSchema: GenEnum<KeyringOperation>;
+/**
+ * How a request ended.
+ *
+ * @generated from enum leaflow.fleet.privilege.v1.PrivilegeOutcome
+ */
+export declare enum PrivilegeOutcome {
+    /**
+     * @generated from enum value: PRIVILEGE_OUTCOME_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * A person approved it.
+     *
+     * @generated from enum value: PRIVILEGE_OUTCOME_APPROVED = 1;
+     */
+    APPROVED = 1,
+    /**
+     * A person denied it.
+     *
+     * @generated from enum value: PRIVILEGE_OUTCOME_DENIED = 2;
+     */
+    DENIED = 2,
+    /**
+     * Nobody decided before the deadline.
+     *
+     * @generated from enum value: PRIVILEGE_OUTCOME_EXPIRED = 3;
+     */
+    EXPIRED = 3,
+    /**
+     * The asking program gave up, such as when sudo was interrupted.
+     *
+     * @generated from enum value: PRIVILEGE_OUTCOME_CANCELLED = 4;
+     */
+    CANCELLED = 4
+}
+/**
+ * Describes the enum leaflow.fleet.privilege.v1.PrivilegeOutcome.
+ */
+export declare const PrivilegeOutcomeSchema: GenEnum<PrivilegeOutcome>;
+/**
+ * Decides on the platform the PAM authentications of directory accounts
+ * (leaflow.fleet.directory.v1), so that sudo works where no participant can
+ * approve, such as after an SSH login, and its owner can approve from any of
+ * their devices. Served by the service on daemon connections
+ * (leaflow.fleet.control.v1).
+ *
+ * The daemon asks for every PAM authentication of a directory account, at the
+ * same time as it shows the request to the participants of the session the
+ * process belongs to, if any. The first decision counts: the daemon cancels
+ * this call (CallCancel) once a participant decides, and stops showing the
+ * request once this call answers. A decision of the platform is not signed; the
+ * daemon trusts it as it trusts the service for the directory.
+ *
+ * Unlike a participant, the platform keeps the request's claims with the
+ * request and shows them to the account's owner: at most the first 4 KiB of
+ * command_line, and remote_host and tty.
+ *
+ * @generated from service leaflow.fleet.privilege.v1.PrivilegeService
+ */
+export declare const PrivilegeService: GenService<{
+    /**
+     * Decides a request. While the account's owner has set the machine to
+     * approve their requests without asking, the request is approved at once.
+     * Otherwise the owner is asked on the platform, and the answer is their
+     * decision, or EXPIRED once expires_at passes without one. A call without
+     * a timeout runs until expires_at.
+     *
+     * Asking again with the request_id of a request the machine asked about
+     * before continues that request: after its connection dropped, the daemon
+     * asks again with the same PrivilegeRequest and gets the decision on it.
+     *
+     * Fails with:
+     *   - NOT_FOUND and reason ACCOUNT_NOT_FOUND when the username of the
+     *     authentication is not an account of the machine's directory;
+     *   - PERMISSION_DENIED and reason PRIVILEGE_NOT_ALLOWED when the account
+     *     may not become root on the machine (Account.admin), or the operation
+     *     is not a PAM authentication.
+     *
+     * @generated from rpc leaflow.fleet.privilege.v1.PrivilegeService.DecidePrivilegeRequest
+     */
+    decidePrivilegeRequest: {
+        methodKind: "unary";
+        input: typeof DecidePrivilegeRequestRequestSchema;
+        output: typeof DecidePrivilegeRequestResponseSchema;
+    };
+}>;