Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

21.0 KB
Raw Blame
import { z } from "zod";

export enum TableName {
  Users = "users",
  EmailDomains = "email_domains",
  // ssh_* tables were dropped with the SSH product; members kept for historical migrations
  SshHostGroup = "ssh_host_groups",
  SshHostGroupMembership = "ssh_host_group_memberships",
  SshHost = "ssh_hosts",
  SshHostLoginUser = "ssh_host_login_users",
  SshHostLoginUserMapping = "ssh_host_login_user_mappings",
  SshCertificateAuthority = "ssh_certificate_authorities",
  SshCertificateAuthoritySecret = "ssh_certificate_authority_secrets",
  SshCertificateTemplate = "ssh_certificate_templates",
  SshCertificate = "ssh_certificates",
  SshCertificateBody = "ssh_certificate_bodies",
  CertificateAuthority = "certificate_authorities",
  ExternalCertificateAuthority = "external_certificate_authorities",
  InternalCertificateAuthority = "internal_certificate_authorities",
  CertificateTemplateEstConfig = "certificate_template_est_configs",
  CertificateAuthorityCert = "certificate_authority_certs",
  CertificateAuthoritySecret = "certificate_authority_secret",
  CertificateAuthorityCrl = "certificate_authority_crl",
  Certificate = "certificates",
  CertificateBody = "certificate_bodies",
  CertificateRequests = "certificate_requests",
  CertificateSecret = "certificate_secrets",
  CertificateTemplate = "certificate_templates",
  PkiCertificateTemplateV2 = "pki_certificate_templates_v2",
  PkiCertificatePolicy = "pki_certificate_policies",
  PkiCertificateProfile = "pki_certificate_profiles",
  PkiApplication = "pki_applications",
  PkiApplicationProfile = "pki_application_profiles",
  PkiEstEnrollmentConfig = "pki_est_enrollment_configs",
  PkiApiEnrollmentConfig = "pki_api_enrollment_configs",
  PkiAcmeEnrollmentConfig = "pki_acme_enrollment_configs",
  PkiScepEnrollmentConfig = "pki_scep_enrollment_configs",
  PkiScepTransaction = "pki_scep_transactions",
  PkiScepDynamicChallenge = "pki_scep_dynamic_challenges",
  PkiSubscriber = "pki_subscribers",
  PkiAlert = "pki_alerts",
  PkiAlertsV2 = "pki_alerts_v2",
  PkiAlertChannels = "pki_alert_channels",
  PkiAlertHistory = "pki_alert_history",
  PkiAlertHistoryCertificate = "pki_alert_history_certificate",
  PkiCollection = "pki_collections",
  PkiCollectionItem = "pki_collection_items",
  Alert = "alerts",
  AlertChannel = "alert_channels",
  AlertChannelRecipient = "alert_channel_recipients",
  AlertChannelMembership = "alert_channel_memberships",
  AlertHistory = "alert_history",
  AlertHistoryTarget = "alert_history_target",
  EventOutbox = "event_outbox",
  Groups = "groups",
  GroupProjectMembership = "group_project_memberships",
  GroupProjectMembershipRole = "group_project_membership_roles",
  ExternalGroupOrgRoleMapping = "external_group_org_role_mappings",
  UserGroupMembership = "user_group_membership",
  IdentityGroupMembership = "identity_group_membership",
  UserAliases = "user_aliases",
  UserEncryptionKey = "user_encryption_keys",
  AuthTokens = "auth_tokens",
  AuthTokenSession = "auth_token_sessions",
  BackupPrivateKey = "backup_private_key",
  Organization = "organizations",
  OrgMembership = "org_memberships",
  OrgRoles = "org_roles",
  OrgBot = "org_bots",
  IncidentContact = "incident_contacts",
  UserAction = "user_actions",
  UserSecretActivation = "user_secret_activation",
  SignupOnboardingResponse = "signup_onboarding_responses",
  SuperAdmin = "super_admin",
  // dropped with the SSH product; member kept for historical migrations
  ProjectSshConfig = "project_ssh_configs",
  Project = "projects",
  ProjectBot = "project_bots",
  Environment = "project_environments",
  ProjectMembership = "project_memberships",
  ProjectRoles = "project_roles",
  ProjectUserAdditionalPrivilege = "project_user_additional_privilege",
  ProjectUserMembershipRole = "project_user_membership_roles",
  ProjectKeys = "project_keys",
  ProjectTemplates = "project_templates",
  ProjectTemplateUserMembership = "project_template_user_memberships",
  ProjectTemplateGroupMembership = "project_template_group_memberships",
  ProjectTemplateIdentityMembership = "project_template_identity_memberships",
  Secret = "secrets",
  SecretReference = "secret_references",
  SecretSharing = "secret_sharing",
  OrganizationAsset = "organization_assets",
  SecretBlindIndex = "secret_blind_indexes",
  SecretVersion = "secret_versions",
  SecretFolder = "secret_folders",
  SecretFolderVersion = "secret_folder_versions",
  SecretImport = "secret_imports",
  ProjectFolderGrant = "project_folder_grants",
  Snapshot = "secret_snapshots",
  SnapshotSecret = "secret_snapshot_secrets",
  SnapshotFolder = "secret_snapshot_folders",
  SecretTag = "secret_tags",
  Integration = "integrations",
  IntegrationAuth = "integration_auths",
  ServiceToken = "service_tokens",
  Webhook = "webhooks",
  Identity = "identities",
  IdentityAccessToken = "identity_access_tokens",
  IdentityAccessTokenRevocation = "identity_access_token_revocations",
  IdentityTokenAuth = "identity_token_auths",
  IdentityUniversalAuth = "identity_universal_auths",
  IdentityKubernetesAuth = "identity_kubernetes_auths",
  IdentityGcpAuth = "identity_gcp_auths",
  IdentityAzureAuth = "identity_azure_auths",
  IdentityUaClientSecret = "identity_ua_client_secrets",
  IdentityAliCloudAuth = "identity_alicloud_auths",
  IdentityAwsAuth = "identity_aws_auths",
  IdentityOciAuth = "identity_oci_auths",
  IdentityOidcAuth = "identity_oidc_auths",
  IdentityJwtAuth = "identity_jwt_auths",
  IdentityLdapAuth = "identity_ldap_auths",
  IdentityTlsCertAuth = "identity_tls_cert_auths",
  IdentitySpiffeAuth = "identity_spiffe_auths",
  IdentityOrgMembership = "identity_org_memberships",
  IdentityProjectMembership = "identity_project_memberships",
  IdentityProjectMembershipRole = "identity_project_membership_role",
  IdentityProjectAdditionalPrivilege = "identity_project_additional_privilege",
  IdentityAuthTemplate = "identity_auth_templates",
  // used by both identity and users
  IdentityMetadata = "identity_metadata",
  ResourceMetadata = "resource_metadata",
  ScimToken = "scim_tokens",
  AccessApprovalPolicy = "access_approval_policies",
  AccessApprovalPolicyApprover = "access_approval_policies_approvers",
  AccessApprovalPolicyBypasser = "access_approval_policies_bypassers",
  AccessApprovalRequest = "access_approval_requests",
  AccessApprovalRequestReviewer = "access_approval_requests_reviewers",
  AccessApprovalPolicyEnvironment = "access_approval_policies_environments",
  ProjectAccessRequest = "project_access_requests",
  SecretApprovalPolicy = "secret_approval_policies",
  SecretApprovalPolicyApprover = "secret_approval_policies_approvers",
  SecretApprovalPolicyBypasser = "secret_approval_policies_bypassers",
  SecretApprovalRequest = "secret_approval_requests",
  SecretApprovalRequestReviewer = "secret_approval_requests_reviewers",
  SecretApprovalRequestSecret = "secret_approval_requests_secrets",
  SecretApprovalRequestSecretTag = "secret_approval_request_secret_tags",
  SecretApprovalPolicyEnvironment = "secret_approval_policies_environments",
  SamlConfig = "saml_configs",
  LdapConfig = "ldap_configs",
  OidcConfig = "oidc_configs",
  LdapGroupMap = "ldap_group_maps",
  AuditLog = "audit_logs",
  AuditLogStream = "audit_log_streams",
  AuditLogStreamOutbox = "audit_log_stream_outbox",
  AuditLogSettings = "audit_log_settings",
  GitAppInstallSession = "git_app_install_sessions",
  GitAppOrg = "git_app_org",
  SecretScanningGitRisk = "secret_scanning_git_risks",
  TrustedIps = "trusted_ips",
  DynamicSecret = "dynamic_secrets",
  DynamicSecretLease = "dynamic_secret_leases",
  SecretV2 = "secrets_v2",
  SecretReferenceV2 = "secret_references_v2",
  SecretReadActivity = "secret_read_activity",
  SecretVersionV2 = "secret_versions_v2",
  SecretApprovalRequestSecretV2 = "secret_approval_requests_secrets_v2",
  SecretApprovalRequestSecretTagV2 = "secret_approval_request_secret_tags_v2",
  SnapshotSecretV2 = "secret_snapshot_secrets_v2",
  ProjectSplitBackfillIds = "project_split_backfill_ids",
  UserNotifications = "user_notifications",
  ScimEvents = "scim_events",
  // Gateway v1. Retired: nothing reads or writes these tables, or the gatewayId columns on
  // dynamic_secrets / identity_kubernetes_auths / identity_auth_templates that point at them.
  // They are kept populated so the removal can be reverted without data loss.
  OrgGatewayConfig = "org_gateway_config",
  Gateway = "gateways",
  ProjectGateway = "project_gateways",
  // junction tables with tags
  SecretV2JnTag = "secret_v2_tag_junction",
  JnSecretTag = "secret_tag_junction",
  SecretVersionTag = "secret_version_tag_junction",
  SecretVersionV2Tag = "secret_version_v2_tag_junction",
  // KMS Service
  KmsServerRootConfig = "kms_root_config",
  KmsLegacyEncryptionKey = "kms_legacy_encryption_keys",
  KmsKekHistory = "kms_kek_history",
  KmsKey = "kms_keys",
  ExternalKms = "external_kms",
  InternalKms = "internal_kms",
  InternalKmsKeyVersion = "internal_kms_key_version",
  TotpConfig = "totp_configs",
  WebAuthnCredential = "webauthn_credentials",
  UserMfaRecoveryCode = "user_mfa_recovery_codes",
  // @depreciated
  KmsKeyVersion = "kms_key_versions",
  WorkflowIntegrations = "workflow_integrations",
  SlackIntegrations = "slack_integrations",
  ProjectSlackConfigs = "project_slack_configs",
  AppConnection = "app_connections",
  AppConnectionCredentialRotation = "app_connection_credential_rotations",
  HsmConnector = "hsm_connectors",
  SecretSync = "secret_syncs",
  PkiSync = "pki_syncs",
  CertificateSync = "certificate_syncs",
  KmipClient = "kmip_clients",
  KmipOrgConfig = "kmip_org_configs",
  KmipOrgServerCertificates = "kmip_org_server_certificates",
  KmipClientCertificates = "kmip_client_certificates",
  KmipServer = "kmip_servers",
  SecretRotationV2 = "secret_rotations_v2",
  SecretRotationV2SecretMapping = "secret_rotation_v2_secret_mappings",
  MicrosoftTeamsIntegrations = "microsoft_teams_integrations",
  ProjectMicrosoftTeamsConfigs = "project_microsoft_teams_configs",
  SecretReminderRecipients = "secret_reminder_recipients", // TODO(Carlos): Remove this in the future after migrating to the new reminder recipients table
  GithubOrgSyncConfig = "github_org_sync_configs",
  GitHubApp = "github_apps",
  GitHubAppConnection = "github_app_connections",
  FolderCommit = "folder_commits",
  FolderCommitChanges = "folder_commit_changes",
  FolderCheckpoint = "folder_checkpoints",
  FolderCheckpointResources = "folder_checkpoint_resources",
  FolderTreeCheckpoint = "folder_tree_checkpoints",
  FolderTreeCheckpointResources = "folder_tree_checkpoint_resources",
  SecretScanningDataSource = "secret_scanning_data_sources",
  SecretScanningResource = "secret_scanning_resources",
  SecretScanningScan = "secret_scanning_scans",
  SecretScanningFinding = "secret_scanning_findings",
  SecretScanningConfig = "secret_scanning_configs",

  Membership = "memberships",
  MembershipRole = "membership_roles",
  Role = "roles",
  AdditionalPrivilege = "additional_privileges",

  Namespace = "namespaces",

  // reminders
  Reminder = "reminders",
  ReminderRecipient = "reminders_recipients",

  // gateway v2
  InstanceRelayConfig = "instance_relay_config",
  OrgRelayConfig = "org_relay_config",
  OrgGatewayConfigV2 = "org_gateway_config_v2",
  Relay = "relays",
  GatewayV2 = "gateways_v2",
  ResourceAuthMethod = "resource_auth_methods",
  ResourceAwsAuth = "resource_aws_auths",
  ResourceGcpAuth = "resource_gcp_auths",
  ResourceKubernetesAuth = "resource_kubernetes_auths",
  ResourceTokenAuth = "resource_token_auths",
  GatewayPool = "gateway_pools",
  GatewayPoolMembership = "gateway_pool_memberships",

  KeyValueStore = "key_value_store",

  // PAM
  PamAccountTemplate = "pam_account_templates",
  PamFolder = "pam_folders",
  PamFolderNotificationConfig = "pam_folder_notification_configs",
  PamResource = "pam_resources",
  PamAccount = "pam_accounts",
  PamSession = "pam_sessions",
  PamSessionEventBatch = "pam_session_event_batches",
  PamSessionEventChunk = "pam_session_event_chunks",
  PamProjectRecordingConfig = "pam_project_recording_configs",
  PamDiscoverySource = "pam_discovery_sources",
  PamDiscoverySourceRun = "pam_discovery_source_runs",
  PamDiscoveredAccount = "pam_discovered_accounts",
  PamDiscoverySourceResource = "pam_discovery_source_resources",
  PamDiscoverySourceAccount = "pam_discovery_source_accounts",
  PamDiscoverySourceDependency = "pam_discovery_source_dependencies",
  PamAccountDependency = "pam_account_dependencies",
  PamResourceRotationRule = "pam_resource_rotation_rules",
  PamResourceFavorite = "pam_resource_favorites",
  PamDomain = "pam_domains",
  PamAccountPolicy = "pam_account_policies",
  AgentVaultAccessBundle = "agent_vault_access_bundles",
  AgentVaultService = "agent_vault_services",
  AgentVaultServiceCustomHeader = "agent_vault_service_custom_headers",
  AgentVaultServiceSubstitution = "agent_vault_service_substitutions",
  AgentVaultVariable = "agent_vault_variables",
  AgentVaultServiceVariableReference = "agent_vault_service_variable_references",
  AgentVaultPersonalValue = "agent_vault_personal_values",
  AgentVaultPersonalValueReference = "agent_vault_personal_value_references",
  AgentVaultSession = "agent_vault_sessions",
  AgentVaultSessionAccessBundle = "agent_vault_session_access_bundles",
  AgentVaultSessionInlineService = "agent_vault_session_inline_services",
  AgentVaultDelegation = "agent_vault_delegations",
  AgentVaultDelegationSubject = "agent_vault_delegation_subjects",
  AgentVaultProxy = "agent_vault_proxies",
  AgentVaultSessionLogConfig = "agent_vault_session_log_configs",
  AgentVaultSkill = "agent_vault_skills",
  AgentVaultSkillVersion = "agent_vault_skill_versions",
  AgentVaultAccessBundleSkill = "agent_vault_access_bundle_skills",
  // Dropped; kept only for the migrations that create and drop it.
  AgentVaultSessionLogChunk = "agent_vault_session_log_chunks",

  ExternalMigrationConfig = "external_migration_configs",

  // PKI ACME
  PkiAcmeAccount = "pki_acme_accounts",
  PkiAcmeOrder = "pki_acme_orders",
  PkiAcmeOrderAuth = "pki_acme_order_auths",
  PkiAcmeAuth = "pki_acme_auths",
  PkiAcmeChallenge = "pki_acme_challenges",

  // PKI Discovery
  PkiDiscoveryConfig = "pki_discovery_configs",
  PkiCertificateInstallation = "pki_certificate_installations",
  PkiDiscoveryInstallation = "pki_discovery_installations",
  PkiCertificateInstallationCert = "pki_certificate_installation_certs",
  PkiDiscoveryScanHistory = "pki_discovery_scan_history",

  // PKI Cleanup
  CertificateCleanupConfig = "certificate_cleanup_configs",

  // PKI Inventory Views
  CertificateInventoryView = "certificate_inventory_views",

  // AI (ai_mcp_* tables were dropped with Agent Sentinel; members kept for historical migrations)
  AiMcpServer = "ai_mcp_servers",
  AiMcpServerTool = "ai_mcp_server_tools",
  AiMcpServerUserCredential = "ai_mcp_server_user_credentials",
  AiMcpEndpoint = "ai_mcp_endpoints",
  AiMcpEndpointServer = "ai_mcp_endpoint_servers",
  AiMcpEndpointServerTool = "ai_mcp_endpoint_server_tools",
  AiMcpActivityLog = "ai_mcp_activity_logs",

  // Approval Policies
  ApprovalPolicies = "approval_policies",
  ApprovalPolicySteps = "approval_policy_steps",
  ApprovalPolicyStepApprovers = "approval_policy_step_approvers",
  ApprovalPolicyBypassers = "approval_policy_bypassers",
  ApprovalPolicyAutoApprovalInputs = "approval_policy_auto_approval_inputs",
  ApprovalPolicyAutoApprovalRules = "approval_policy_auto_approval_rules",
  ApprovalPolicyAutoApprovalConditions = "approval_policy_auto_approval_conditions",
  ApprovalPolicySecretEnvironment = "approval_policy_secret_environments",
  ApprovalRequests = "approval_requests",
  ApprovalRequestSteps = "approval_request_steps",
  ApprovalRequestStepEligibleApprovers = "approval_request_step_eligible_approvers",
  ApprovalRequestApprovals = "approval_request_approvals",
  ApprovalRequestGrants = "approval_request_grants",
  SecretChangeRequests = "secret_change_requests",
  DelegatedApprovalPolicies = "delegated_approval_policies",
  DelegatedApprovalRequests = "delegated_approval_requests",

  // Code Signing
  PkiSigners = "pki_signers",
  PkiSignerCertificateIssuanceJobs = "pki_signer_certificate_issuance_jobs",
  PkiSigningOperations = "pki_signing_operations",

  CaSigningConfig = "ca_signing_configs",
  SecretValidationRule = "secret_validation_rules",

  // OAuth 2.0 authorization server (Infisical as an OAuth provider)
  OauthClient = "oauth_clients",

  // Honey Tokens
  HoneyTokenConfig = "honey_token_configs",
  HoneyToken = "honey_tokens",
  HoneyTokenEvent = "honey_token_events",
  HoneyTokenSecretMapping = "honey_token_secret_mappings",

  // Audit Reports (exportable compliance reports)
  AuditReport = "audit_reports",

  // Secrets Brokering (Agent Proxy)
  OrgAgentProxyConfig = "org_agent_proxy_config",
  ProxiedService = "proxied_services",
  ProxiedServiceCredential = "proxied_service_credentials",

  // Deprecated - Not used anymore now that Redis is persistent
  DeprecatedDurableQueueJobs = "queue_jobs",
  DeprecatedSecretRotationV1 = "secret_rotations",
  DeprecatedSecretRotationOutput = "secret_rotation_outputs",
  DeprecatedSecretRotationOutputV2 = "secret_rotation_output_v2",
  DeprecatedApiKey = "api_keys",
  DeprecatedRateLimit = "rate_limit"
}

export type TImmutableDBKeys = "id" | "createdAt" | "updatedAt" | "commitId";

export const UserDeviceSchema = z
  .object({
    ip: z.string(),
    userAgent: z.string()
  })
  .array()
  .default([]);

export const ServiceTokenScopes = z
  .object({
    environment: z.string(),
    secretPath: z.string().default("/")
  })
  .array();

export enum OrgMembershipRole {
  Admin = "admin",
  Member = "member",
  NoAccess = "no-access",
  Custom = "custom"
}

export enum OrgMembershipStatus {
  Invited = "invited",
  Accepted = "accepted"
}

export enum ProjectMembershipRole {
  // general
  Admin = "admin",
  Member = "member",
  Custom = "custom",
  Viewer = "viewer",
  NoAccess = "no-access",
  // kms
  KmsCryptographicOperator = "cryptographic-operator"
}

export enum ResourceMembershipRole {
  Admin = "admin",
  Operator = "operator",
  Auditor = "auditor",
  Custom = "custom"
}

// Stored in additional_privileges.role for folder-scoped grants. The tiers are cumulative: each is
// a superset of the one above it.
export enum SecretFolderRole {
  List = "list",
  Read = "read",
  Edit = "edit",
  Manage = "manage",
  FullAccess = "full-access"
}

export enum ResourceType {
  CertificateApplication = "certificate-application",
  Signer = "pki-signer",
  PamFolder = "pam-folder",
  PamAccount = "pam-account",
  AgentVaultAccessBundle = "agent-vault-access-bundle"
}

export enum SecretEncryptionAlgo {
  AES_256_GCM = "aes-256-gcm"
}

export enum SecretKeyEncoding {
  UTF8 = "utf8",
  BASE64 = "base64",
  HEX = "hex"
}

export enum SecretType {
  Shared = "shared",
  Personal = "personal"
}

export enum ProjectVersion {
  V1 = 1,
  V2 = 2,
  V3 = 3
}

export enum ProjectUpgradeStatus {
  InProgress = "IN_PROGRESS",
  // Completed -> Will be null if completed. So a completed status is not needed
  Failed = "FAILED"
}

export enum IdentityAuthMethod {
  TOKEN_AUTH = "token-auth",
  UNIVERSAL_AUTH = "universal-auth",
  KUBERNETES_AUTH = "kubernetes-auth",
  GCP_AUTH = "gcp-auth",
  ALICLOUD_AUTH = "alicloud-auth",
  AWS_AUTH = "aws-auth",
  AZURE_AUTH = "azure-auth",
  TLS_CERT_AUTH = "tls-cert-auth",
  OCI_AUTH = "oci-auth",
  OIDC_AUTH = "oidc-auth",
  JWT_AUTH = "jwt-auth",
  LDAP_AUTH = "ldap-auth",
  SPIFFE_AUTH = "spiffe-auth"
}

export enum ProjectType {
  SecretManager = "secret-manager",
  CertificateManager = "cert-manager",
  KMS = "kms",
  SecretScanning = "secret-scanning",
  PAM = "pam",
  AgentVault = "agent-vault"
}

// These products resolve every non-admin slug to their member rule set, so a viewer, no-access or
// custom role would promise less access than it grants. Write paths reject those roles outright;
// rows written before a product joined this list are not re-validated.
const ADMIN_MEMBER_ONLY_PRODUCT_LABELS: Partial<Record<ProjectType, string>> = {
  [ProjectType.CertificateManager]: "Certificate Manager",
  [ProjectType.PAM]: "Privileged Access Manager",
  [ProjectType.AgentVault]: "Agent Vault"
};

export const getAdminMemberOnlyProductLabel = (projectType?: string | null) =>
  projectType ? ADMIN_MEMBER_ONLY_PRODUCT_LABELS[projectType as ProjectType] : undefined;

export enum ActionProjectType {
  SecretManager = ProjectType.SecretManager,
  CertificateManager = ProjectType.CertificateManager,
  KMS = ProjectType.KMS,
  SecretScanning = ProjectType.SecretScanning,
  PAM = ProjectType.PAM,
  AgentVault = ProjectType.AgentVault,
  // project operations that happen on all types
  Any = "any"
}

export enum OrganizationActionScope {
  ChildOrganization = "child-organization-only",
  ParentOrganization = "parent-organization-only",
  Any = "any"
}

export enum TemporaryPermissionMode {
  Relative = "relative"
}

export enum MembershipActors {
  Group = "group",
  User = "user",
  Identity = "identity"
}

export enum SortDirection {
  ASC = "asc",
  DESC = "desc"
}

export enum AccessScope {
  Organization = "organization",
  Project = "project"
}

export const RESOURCE_SCOPE = "resource";

export type AccessScopeData =
  | {
      scope: AccessScope.Organization;
      orgId: string;
    }
  | {
      scope: AccessScope.Project;
      orgId: string;
      projectId: string;
    };