//! Basic API types used by most of the PBS code. use serde::{Deserialize, Serialize}; use proxmox::api::api; use proxmox::api::schema::{ ApiStringFormat, ApiType, ArraySchema, EnumEntry, IntegerSchema, ReturnType, Schema, StringSchema, }; use proxmox::const_regex; use proxmox::{IPRE, IPRE_BRACKET, IPV4OCTET, IPV4RE, IPV6H16, IPV6LS32, IPV6RE}; #[rustfmt::skip] #[macro_export] macro_rules! PROXMOX_SAFE_ID_REGEX_STR { () => { r"(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)" }; } #[rustfmt::skip] #[macro_export] macro_rules! BACKUP_ID_RE { () => (r"[A-Za-z0-9_][A-Za-z0-9._\-]*") } #[rustfmt::skip] #[macro_export] macro_rules! BACKUP_TYPE_RE { () => (r"(?:host|vm|ct)") } #[rustfmt::skip] #[macro_export] macro_rules! BACKUP_TIME_RE { () => (r"[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z") } #[rustfmt::skip] #[macro_export] macro_rules! SNAPSHOT_PATH_REGEX_STR { () => ( concat!(r"(", BACKUP_TYPE_RE!(), ")/(", BACKUP_ID_RE!(), ")/(", BACKUP_TIME_RE!(), r")") ); } #[macro_use] mod userid; pub use userid::Authid; pub use userid::Userid; pub use userid::{Realm, RealmRef}; pub use userid::{Tokenname, TokennameRef}; pub use userid::{Username, UsernameRef}; pub use userid::{PROXMOX_GROUP_ID_SCHEMA, PROXMOX_TOKEN_ID_SCHEMA, PROXMOX_TOKEN_NAME_SCHEMA}; #[macro_use] mod user; pub use user::{ApiToken, User, UserWithTokens}; pub use user::{ EMAIL_SCHEMA, ENABLE_USER_SCHEMA, EXPIRE_USER_SCHEMA, FIRST_NAME_SCHEMA, LAST_NAME_SCHEMA, }; pub mod upid; pub use upid::UPID; mod crypto; pub use crypto::{CryptMode, Fingerprint}; pub mod file_restore; mod remote; pub use remote::*; #[rustfmt::skip] #[macro_use] mod local_macros { macro_rules! DNS_LABEL { () => (r"(?:[a-zA-Z0-9](?:[a-zA-Z0-9\-]*[a-zA-Z0-9])?)") } macro_rules! DNS_NAME { () => (concat!(r"(?:(?:", DNS_LABEL!() , r"\.)*", DNS_LABEL!(), ")")) } macro_rules! CIDR_V4_REGEX_STR { () => (concat!(r"(?:", IPV4RE!(), r"/\d{1,2})$")) } macro_rules! CIDR_V6_REGEX_STR { () => (concat!(r"(?:", IPV6RE!(), r"/\d{1,3})$")) } macro_rules! DNS_ALIAS_LABEL { () => (r"(?:[a-zA-Z0-9_](?:[a-zA-Z0-9\-]*[a-zA-Z0-9])?)") } macro_rules! DNS_ALIAS_NAME { () => (concat!(r"(?:(?:", DNS_ALIAS_LABEL!() , r"\.)*", DNS_ALIAS_LABEL!(), ")")) } } const_regex! { pub IP_V4_REGEX = concat!(r"^", IPV4RE!(), r"$"); pub IP_V6_REGEX = concat!(r"^", IPV6RE!(), r"$"); pub IP_REGEX = concat!(r"^", IPRE!(), r"$"); pub CIDR_V4_REGEX = concat!(r"^", CIDR_V4_REGEX_STR!(), r"$"); pub CIDR_V6_REGEX = concat!(r"^", CIDR_V6_REGEX_STR!(), r"$"); pub CIDR_REGEX = concat!(r"^(?:", CIDR_V4_REGEX_STR!(), "|", CIDR_V6_REGEX_STR!(), r")$"); pub HOSTNAME_REGEX = r"^(?:[a-zA-Z0-9](?:[a-zA-Z0-9\-]*[a-zA-Z0-9])?)$"; pub DNS_NAME_REGEX = concat!(r"^", DNS_NAME!(), r"$"); pub DNS_ALIAS_REGEX = concat!(r"^", DNS_ALIAS_NAME!(), r"$"); pub DNS_NAME_OR_IP_REGEX = concat!(r"^(?:", DNS_NAME!(), "|", IPRE!(), r")$"); pub SHA256_HEX_REGEX = r"^[a-f0-9]{64}$"; // fixme: define in common_regex ? pub PASSWORD_REGEX = r"^[[:^cntrl:]]*$"; // everything but control characters pub UUID_REGEX = r"^[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}$"; pub BACKUP_TYPE_REGEX = concat!(r"^(", BACKUP_TYPE_RE!(), r")$"); pub BACKUP_ID_REGEX = concat!(r"^", BACKUP_ID_RE!(), r"$"); pub BACKUP_DATE_REGEX = concat!(r"^", BACKUP_TIME_RE!() ,r"$"); pub GROUP_PATH_REGEX = concat!(r"^(", BACKUP_TYPE_RE!(), ")/(", BACKUP_ID_RE!(), r")$"); pub BACKUP_FILE_REGEX = r"^.*\.([fd]idx|blob)$"; pub SNAPSHOT_PATH_REGEX = concat!(r"^", SNAPSHOT_PATH_REGEX_STR!(), r"$"); pub FINGERPRINT_SHA256_REGEX = r"^(?:[0-9a-fA-F][0-9a-fA-F])(?::[0-9a-fA-F][0-9a-fA-F]){31}$"; /// Regex for safe identifiers. /// /// This /// [article](https://dwheeler.com/essays/fixing-unix-linux-filenames.html) /// contains further information why it is reasonable to restict /// names this way. This is not only useful for filenames, but for /// any identifier command line tools work with. pub PROXMOX_SAFE_ID_REGEX = concat!(r"^", PROXMOX_SAFE_ID_REGEX_STR!(), r"$"); pub SINGLE_LINE_COMMENT_REGEX = r"^[[:^cntrl:]]*$"; pub BACKUP_REPO_URL_REGEX = concat!( r"^^(?:(?:(", USER_ID_REGEX_STR!(), "|", APITOKEN_ID_REGEX_STR!(), ")@)?(", DNS_NAME!(), "|", IPRE_BRACKET!(), "):)?(?:([0-9]{1,5}):)?(", PROXMOX_SAFE_ID_REGEX_STR!(), r")$" ); pub BLOCKDEVICE_NAME_REGEX = r"^(:?(:?h|s|x?v)d[a-z]+)|(:?nvme\d+n\d+)$"; } pub const IP_V4_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&IP_V4_REGEX); pub const IP_V6_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&IP_V6_REGEX); pub const IP_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&IP_REGEX); pub const CIDR_V4_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&CIDR_V4_REGEX); pub const CIDR_V6_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&CIDR_V6_REGEX); pub const CIDR_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&CIDR_REGEX); pub const DNS_NAME_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&DNS_NAME_REGEX); pub const DNS_NAME_OR_IP_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&DNS_NAME_OR_IP_REGEX); pub const DNS_NAME_OR_IP_SCHEMA: Schema = StringSchema::new("DNS name or IP address.") .format(&DNS_NAME_OR_IP_FORMAT) .schema(); pub const BACKUP_ID_SCHEMA: Schema = StringSchema::new("Backup ID.") .format(&BACKUP_ID_FORMAT) .schema(); pub const BACKUP_TYPE_SCHEMA: Schema = StringSchema::new("Backup type.") .format(&ApiStringFormat::Enum(&[ EnumEntry::new("vm", "Virtual Machine Backup"), EnumEntry::new("ct", "Container Backup"), EnumEntry::new("host", "Host Backup"), ])) .schema(); pub const BACKUP_TIME_SCHEMA: Schema = IntegerSchema::new("Backup time (Unix epoch.)") .minimum(1_547_797_308) .schema(); pub const DATASTORE_SCHEMA: Schema = StringSchema::new("Datastore name.") .format(&PROXMOX_SAFE_ID_FORMAT) .min_length(3) .max_length(32) .schema(); pub const REALM_ID_SCHEMA: Schema = StringSchema::new("Realm name.") .format(&PROXMOX_SAFE_ID_FORMAT) .min_length(2) .max_length(32) .schema(); pub const FINGERPRINT_SHA256_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&FINGERPRINT_SHA256_REGEX); pub const CERT_FINGERPRINT_SHA256_SCHEMA: Schema = StringSchema::new("X509 certificate fingerprint (sha256).") .format(&FINGERPRINT_SHA256_FORMAT) .schema(); pub const PRUNE_SCHEMA_KEEP_DAILY: Schema = IntegerSchema::new("Number of daily backups to keep.") .minimum(1) .schema(); pub const PRUNE_SCHEMA_KEEP_HOURLY: Schema = IntegerSchema::new("Number of hourly backups to keep.") .minimum(1) .schema(); pub const PRUNE_SCHEMA_KEEP_LAST: Schema = IntegerSchema::new("Number of backups to keep.") .minimum(1) .schema(); pub const PRUNE_SCHEMA_KEEP_MONTHLY: Schema = IntegerSchema::new("Number of monthly backups to keep.") .minimum(1) .schema(); pub const PRUNE_SCHEMA_KEEP_WEEKLY: Schema = IntegerSchema::new("Number of weekly backups to keep.") .minimum(1) .schema(); pub const PRUNE_SCHEMA_KEEP_YEARLY: Schema = IntegerSchema::new("Number of yearly backups to keep.") .minimum(1) .schema(); pub const PROXMOX_SAFE_ID_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&PROXMOX_SAFE_ID_REGEX); pub const SINGLE_LINE_COMMENT_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&SINGLE_LINE_COMMENT_REGEX); pub const SINGLE_LINE_COMMENT_SCHEMA: Schema = StringSchema::new("Comment (single line).") .format(&SINGLE_LINE_COMMENT_FORMAT) .schema(); pub const PROXMOX_CONFIG_DIGEST_SCHEMA: Schema = StringSchema::new( "Prevent changes if current configuration file has different \ SHA256 digest. This can be used to prevent concurrent \ modifications.", ) .format(&PVE_CONFIG_DIGEST_FORMAT) .schema(); pub const BACKUP_ID_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&BACKUP_ID_REGEX); /// API schema format definition for repository URLs pub const BACKUP_REPO_URL: ApiStringFormat = ApiStringFormat::Pattern(&BACKUP_REPO_URL_REGEX); #[api( properties: { "upid": { optional: true, type: UPID, }, }, )] #[derive(Clone, Serialize, Deserialize)] #[serde(rename_all = "kebab-case")] /// Garbage collection status. pub struct GarbageCollectionStatus { pub upid: Option, /// Number of processed index files. pub index_file_count: usize, /// Sum of bytes referred by index files. pub index_data_bytes: u64, /// Bytes used on disk. pub disk_bytes: u64, /// Chunks used on disk. pub disk_chunks: usize, /// Sum of removed bytes. pub removed_bytes: u64, /// Number of removed chunks. pub removed_chunks: usize, /// Sum of pending bytes (pending removal - kept for safety). pub pending_bytes: u64, /// Number of pending chunks (pending removal - kept for safety). pub pending_chunks: usize, /// Number of chunks marked as .bad by verify that have been removed by GC. pub removed_bad: usize, /// Number of chunks still marked as .bad after garbage collection. pub still_bad: usize, } impl Default for GarbageCollectionStatus { fn default() -> Self { GarbageCollectionStatus { upid: None, index_file_count: 0, index_data_bytes: 0, disk_bytes: 0, disk_chunks: 0, removed_bytes: 0, removed_chunks: 0, pending_bytes: 0, pending_chunks: 0, removed_bad: 0, still_bad: 0, } } } pub const PVE_CONFIG_DIGEST_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&SHA256_HEX_REGEX); pub const CHUNK_DIGEST_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&SHA256_HEX_REGEX); pub const PASSWORD_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&PASSWORD_REGEX); pub const UUID_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&UUID_REGEX); pub const BACKUP_ARCHIVE_NAME_SCHEMA: Schema = StringSchema::new("Backup archive name.") .format(&PROXMOX_SAFE_ID_FORMAT) .schema(); // Complex type definitions #[api( properties: { "filename": { schema: BACKUP_ARCHIVE_NAME_SCHEMA, }, "crypt-mode": { type: CryptMode, optional: true, }, }, )] #[derive(Serialize, Deserialize)] #[serde(rename_all = "kebab-case")] /// Basic information about archive files inside a backup snapshot. pub struct BackupContent { pub filename: String, /// Info if file is encrypted, signed, or neither. #[serde(skip_serializing_if = "Option::is_none")] pub crypt_mode: Option, /// Archive size (from backup manifest). #[serde(skip_serializing_if = "Option::is_none")] pub size: Option, } #[api()] #[derive(Debug, Copy, Clone, PartialEq, Serialize, Deserialize)] #[serde(rename_all = "lowercase")] /// Result of a verify operation. pub enum VerifyState { /// Verification was successful Ok, /// Verification reported one or more errors Failed, } #[api( properties: { upid: { type: UPID, }, state: { type: VerifyState, }, }, )] #[derive(Serialize, Deserialize)] /// Task properties. pub struct SnapshotVerifyState { /// UPID of the verify task pub upid: UPID, /// State of the verification. Enum. pub state: VerifyState, } #[api( properties: { "backup-type": { schema: BACKUP_TYPE_SCHEMA, }, "backup-id": { schema: BACKUP_ID_SCHEMA, }, "backup-time": { schema: BACKUP_TIME_SCHEMA, }, comment: { schema: SINGLE_LINE_COMMENT_SCHEMA, optional: true, }, verification: { type: SnapshotVerifyState, optional: true, }, fingerprint: { type: String, optional: true, }, files: { items: { schema: BACKUP_ARCHIVE_NAME_SCHEMA }, }, owner: { type: Authid, optional: true, }, }, )] #[derive(Serialize, Deserialize)] #[serde(rename_all = "kebab-case")] /// Basic information about backup snapshot. pub struct SnapshotListItem { pub backup_type: String, // enum pub backup_id: String, pub backup_time: i64, /// The first line from manifest "notes" #[serde(skip_serializing_if = "Option::is_none")] pub comment: Option, /// The result of the last run verify task #[serde(skip_serializing_if = "Option::is_none")] pub verification: Option, /// Fingerprint of encryption key #[serde(skip_serializing_if = "Option::is_none")] pub fingerprint: Option, /// List of contained archive files. pub files: Vec, /// Overall snapshot size (sum of all archive sizes). #[serde(skip_serializing_if = "Option::is_none")] pub size: Option, /// The owner of the snapshots group #[serde(skip_serializing_if = "Option::is_none")] pub owner: Option, } #[api( properties: { "backup-type": { schema: BACKUP_TYPE_SCHEMA, }, "backup-id": { schema: BACKUP_ID_SCHEMA, }, "last-backup": { schema: BACKUP_TIME_SCHEMA, }, "backup-count": { type: Integer, }, files: { items: { schema: BACKUP_ARCHIVE_NAME_SCHEMA }, }, owner: { type: Authid, optional: true, }, }, )] #[derive(Serialize, Deserialize)] #[serde(rename_all = "kebab-case")] /// Basic information about a backup group. pub struct GroupListItem { pub backup_type: String, // enum pub backup_id: String, pub last_backup: i64, /// Number of contained snapshots pub backup_count: u64, /// List of contained archive files. pub files: Vec, /// The owner of group #[serde(skip_serializing_if = "Option::is_none")] pub owner: Option, /// The first line from group "notes" #[serde(skip_serializing_if = "Option::is_none")] pub comment: Option, } #[api( properties: { store: { schema: DATASTORE_SCHEMA, }, comment: { optional: true, schema: SINGLE_LINE_COMMENT_SCHEMA, }, }, )] #[derive(Serialize, Deserialize)] #[serde(rename_all = "kebab-case")] /// Basic information about a datastore. pub struct DataStoreListItem { pub store: String, pub comment: Option, } #[api( properties: { "backup-type": { schema: BACKUP_TYPE_SCHEMA, }, "backup-id": { schema: BACKUP_ID_SCHEMA, }, "backup-time": { schema: BACKUP_TIME_SCHEMA, }, }, )] #[derive(Serialize, Deserialize)] #[serde(rename_all = "kebab-case")] /// Prune result. pub struct PruneListItem { pub backup_type: String, // enum pub backup_id: String, pub backup_time: i64, /// Keep snapshot pub keep: bool, } #[api()] #[derive(Default, Serialize, Deserialize)] /// Storage space usage information. pub struct StorageStatus { /// Total space (bytes). pub total: u64, /// Used space (bytes). pub used: u64, /// Available space (bytes). pub avail: u64, } #[api()] #[derive(Serialize, Deserialize, Default)] /// Backup Type group/snapshot counts. pub struct TypeCounts { /// The number of groups of the type. pub groups: u64, /// The number of snapshots of the type. pub snapshots: u64, } #[api( properties: { ct: { type: TypeCounts, optional: true, }, host: { type: TypeCounts, optional: true, }, vm: { type: TypeCounts, optional: true, }, other: { type: TypeCounts, optional: true, }, }, )] #[derive(Serialize, Deserialize, Default)] /// Counts of groups/snapshots per BackupType. pub struct Counts { /// The counts for CT backups pub ct: Option, /// The counts for Host backups pub host: Option, /// The counts for VM backups pub vm: Option, /// The counts for other backup types pub other: Option, } pub const PASSWORD_HINT_SCHEMA: Schema = StringSchema::new("Password hint.") .format(&SINGLE_LINE_COMMENT_FORMAT) .min_length(1) .max_length(64) .schema(); #[api] #[derive(Deserialize, Serialize)] /// RSA public key information pub struct RsaPubKeyInfo { /// Path to key (if stored in a file) #[serde(skip_serializing_if="Option::is_none")] pub path: Option, /// RSA exponent pub exponent: String, /// Hex-encoded RSA modulus pub modulus: String, /// Key (modulus) length in bits pub length: usize, } impl std::convert::TryFrom> for RsaPubKeyInfo { type Error = anyhow::Error; fn try_from(value: openssl::rsa::Rsa) -> Result { let modulus = value.n().to_hex_str()?.to_string(); let exponent = value.e().to_dec_str()?.to_string(); let length = value.size() as usize * 8; Ok(Self { path: None, exponent, modulus, length, }) } } #[api( properties: { upid: { schema: UPID::API_SCHEMA }, }, )] #[derive(Serialize, Deserialize)] /// Task properties. pub struct TaskListItem { pub upid: String, /// The node name where the task is running on. pub node: String, /// The Unix PID pub pid: i64, /// The task start time (Epoch) pub pstart: u64, /// The task start time (Epoch) pub starttime: i64, /// Worker type (arbitrary ASCII string) pub worker_type: String, /// Worker ID (arbitrary ASCII string) pub worker_id: Option, /// The authenticated entity who started the task pub user: Authid, /// The task end time (Epoch) #[serde(skip_serializing_if="Option::is_none")] pub endtime: Option, /// Task end status #[serde(skip_serializing_if="Option::is_none")] pub status: Option, } pub const ADMIN_DATASTORE_LIST_SNAPSHOTS_RETURN_TYPE: ReturnType = ReturnType { optional: false, schema: &ArraySchema::new( "Returns the list of snapshots.", &SnapshotListItem::API_SCHEMA, ).schema(), }; pub const ADMIN_DATASTORE_LIST_SNAPSHOT_FILES_RETURN_TYPE: ReturnType = ReturnType { optional: false, schema: &ArraySchema::new( "Returns the list of archive files inside a backup snapshots.", &BackupContent::API_SCHEMA, ).schema(), }; pub const ADMIN_DATASTORE_LIST_GROUPS_RETURN_TYPE: ReturnType = ReturnType { optional: false, schema: &ArraySchema::new( "Returns the list of backup groups.", &GroupListItem::API_SCHEMA, ).schema(), }; pub const ADMIN_DATASTORE_PRUNE_RETURN_TYPE: ReturnType = ReturnType { optional: false, schema: &ArraySchema::new( "Returns the list of snapshots and a flag indicating if there are kept or removed.", &PruneListItem::API_SCHEMA, ).schema(), }; pub const NODE_TASKS_LIST_TASKS_RETURN_TYPE: ReturnType = ReturnType { optional: false, schema: &ArraySchema::new( "A list of tasks.", &TaskListItem::API_SCHEMA, ).schema(), };