/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ import { HOST_OPERATION_SPECS, operationAllowsRemoteOwner, operationUsesHostPaths, type AccessCredentialPrincipalKind, type ClientCapabilityOwnerIdentity, type ClientCapabilityClientFrame, type OperationKey, type RequestFrame, } from '../protocol/index.js'; export interface RuntimeHostConnectionAuthority { readonly principalKind: 'local_owner' | AccessCredentialPrincipalKind; readonly principalId: string; readonly credentialId?: string; readonly clientInstanceId?: string; readonly capabilityOwner?: ClientCapabilityOwnerIdentity; readonly operationGrants: 'all' | readonly OperationKey[]; readonly canPublishClientCapabilities: boolean; readonly canUseHostPaths: boolean; } export const LOCAL_OWNER_CONNECTION_AUTHORITY = createRuntimeHostConnectionAuthority({ principalKind: 'local_owner', principalId: 'local_os_user', operationGrants: 'all', canPublishClientCapabilities: true, canUseHostPaths: true, }); export function createRuntimeHostConnectionAuthority( input: RuntimeHostConnectionAuthority, ): RuntimeHostConnectionAuthority { if (!/^[A-Za-z0-9_.:-]{1,128}$/.test(input.principalId)) { throw new Error('Runtime Host connection principal is invalid'); } if ( input.principalKind !== 'local_owner' && !/^[A-Za-z0-9_.:-]{1,128}$/.test(input.credentialId ?? '') ) { throw new Error('Runtime Host access credential identity is invalid'); } if ( input.clientInstanceId !== undefined && (input.clientInstanceId.length === 0 || input.clientInstanceId.length > 128) ) { throw new Error('Runtime Host bound Client identity is invalid'); } if (input.capabilityOwner) { if (input.principalKind !== 'capability_provider') { throw new Error('Only a capability provider may declare a Client Capability owner'); } if (!/^[A-Za-z0-9_.:-]{1,128}$/u.test(input.capabilityOwner.principalId)) { throw new Error('Runtime Host Client Capability owner principal is invalid'); } if ( input.capabilityOwner.clientInstanceId.length === 0 || input.capabilityOwner.clientInstanceId.length > 128 ) { throw new Error('Runtime Host Client Capability owner identity is invalid'); } } const operationGrants = input.operationGrants === 'all' ? 'all' : Object.freeze( [...new Set(input.operationGrants)].map((operation) => { if (!Object.hasOwn(HOST_OPERATION_SPECS, operation)) { throw new Error(`Unknown Runtime Host operation grant: ${operation}`); } return operation; }), ); const capabilityOwner = input.capabilityOwner ? Object.freeze({ ...input.capabilityOwner }) : undefined; return Object.freeze({ ...input, operationGrants, ...(capabilityOwner ? { capabilityOwner } : {}), }); } export function authorizeRuntimeHostOperation( authority: RuntimeHostConnectionAuthority, frame: RequestFrame, ): boolean { if ( (authority.principalKind === 'remote_owner' || authority.principalKind === 'capability_provider') && !operationAllowsRemoteOwner(frame.operation) ) { return false; } if (authority.operationGrants !== 'all' && !authority.operationGrants.includes(frame.operation)) { return false; } if ( (frame.operation === 'client.capability.replace' || frame.operation === 'client.capability.unregister') && !authority.canPublishClientCapabilities ) { return false; } return authority.canUseHostPaths || !operationUsesHostPaths(frame); } export function hasRuntimeHostOperationGrant( authority: RuntimeHostConnectionAuthority, operation: OperationKey, ): boolean { return authority.operationGrants === 'all' || authority.operationGrants.includes(operation); } export function authorizeClientCapabilityFrame( authority: RuntimeHostConnectionAuthority, _frame: ClientCapabilityClientFrame, ): boolean { return authority.canPublishClientCapabilities; }