1 /* 2 BAREOS® - Backup Archiving REcovery Open Sourced 3 4 Copyright (C) 2000-2010 Free Software Foundation Europe e.V. 5 Copyright (C) 2016-2019 Bareos GmbH & Co. KG 6 7 This program is Free Software; you can redistribute it and/or 8 modify it under the terms of version three of the GNU Affero General Public 9 License as published by the Free Software Foundation and included 10 in the file LICENSE. 11 12 This program is distributed in the hope that it will be useful, but 13 WITHOUT ANY WARRANTY; without even the implied warranty of 14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15 Affero General Public License for more details. 16 17 You should have received a copy of the GNU Affero General Public License 18 along with this program; if not, write to the Free Software 19 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 20 02110-1301, USA. 21 */ 22 /* 23 * Kern Sibbald, MM 24 */ 25 /** 26 * @file 27 * Stream definitions. Split from baconfig.h Nov 2010 28 */ 29 30 #ifndef BAREOS_INCLUDE_STREAMS_H_ 31 #define BAREOS_INCLUDE_STREAMS_H_ 1 32 33 /* clang-format off */ 34 35 /** 36 * Stream bits -- these bits are new as of 24Nov10 37 */ 38 #define STREAM_BIT_64 (1 << 30) /**< 64 bit stream (not yet implemented) */ 39 #define STREAM_BIT_BITS (1 << 29) /**< Following bits may be set */ 40 #define STREAM_BIT_PLUGIN (1 << 28) /**< Item written by a plugin */ 41 #define STREAM_BIT_DELTA (1 << 27) /**< Stream contains delta data */ 42 #define STREAM_BIT_OFFSETS (1 << 26) /**< Stream has data offset */ 43 #define STREAM_BIT_PORTABLE_DATA (1 << 25) /**< Data is portable */ 44 45 /** 46 * TYPE represents our current (old) stream types -- e.g. values 0 - 2047 47 */ 48 #define STREAMBASE_TYPE 0 /**< base for types */ 49 #define STREAMBITS_TYPE 11 /**< type bit size */ 50 #define STREAMMASK_TYPE (~((~0U)<< STREAMBITS_TYPE) << STREAMBASE_TYPE) 51 /** 52 * Note additional base, bits, and masks can be defined for new 53 * ranges or subranges of stream attributes. 54 */ 55 56 /** 57 * Old, but currently used Stream definitions. Once defined these must NEVER 58 * change as they go on the storage media. 59 * 60 * Note, the following streams are passed from the SD to the DIR 61 * so that they may be put into the catalog (actually only the 62 * stat packet part of the attr record is put in the catalog. 63 * 64 * STREAM_UNIX_ATTRIBUTES 65 * STREAM_UNIX_ATTRIBUTES_EX 66 * STREAM_MD5_DIGEST 67 * STREAM_SHA1_DIGEST 68 * STREAM_SHA256_DIGEST 69 * STREAM_SHA512_DIGEST 70 */ 71 #define STREAM_NONE 0 /**< Reserved Non-Stream */ 72 #define STREAM_UNIX_ATTRIBUTES 1 /**< Generic Unix attributes */ 73 #define STREAM_FILE_DATA 2 /**< Standard uncompressed data */ 74 #define STREAM_MD5_SIGNATURE 3 /**< MD5 signature - Deprecated */ 75 #define STREAM_MD5_DIGEST 3 /**< MD5 digest for the file */ 76 #define STREAM_GZIP_DATA 4 /**< GZip compressed file data - Deprecated */ 77 #define STREAM_UNIX_ATTRIBUTES_EX 5 /**< Extended Unix attr for Win32 EX - Deprecated */ 78 #define STREAM_SPARSE_DATA 6 /**< Sparse data stream */ 79 #define STREAM_SPARSE_GZIP_DATA 7 /**< Sparse gzipped data stream - Deprecated */ 80 #define STREAM_PROGRAM_NAMES 8 /**< Program names for program data */ 81 #define STREAM_PROGRAM_DATA 9 /**< Data needing program */ 82 #define STREAM_SHA1_SIGNATURE 10 /**< SHA1 signature - Deprecated */ 83 #define STREAM_SHA1_DIGEST 10 /**< SHA1 digest for the file */ 84 #define STREAM_WIN32_DATA 11 /**< Win32 BackupRead data */ 85 #define STREAM_WIN32_GZIP_DATA 12 /**< Gzipped Win32 BackupRead data - Deprecated */ 86 #define STREAM_MACOS_FORK_DATA 13 /**< Mac resource fork */ 87 #define STREAM_HFSPLUS_ATTRIBUTES 14 /**< Mac OS extra attributes */ 88 #define STREAM_UNIX_ACCESS_ACL 15 /**< Standard ACL attributes on UNIX - Deprecated */ 89 #define STREAM_UNIX_DEFAULT_ACL 16 /**< Default ACL attributes on UNIX - Deprecated */ 90 #define STREAM_SHA256_DIGEST 17 /**< SHA-256 digest for the file */ 91 #define STREAM_SHA512_DIGEST 18 /**< SHA-512 digest for the file */ 92 #define STREAM_SIGNED_DIGEST 19 /**< Signed File Digest, ASN.1, DER Encoded */ 93 #define STREAM_ENCRYPTED_FILE_DATA 20 /**< Encrypted, uncompressed data */ 94 #define STREAM_ENCRYPTED_WIN32_DATA 21 /**< Encrypted, uncompressed Win32 BackupRead data */ 95 #define STREAM_ENCRYPTED_SESSION_DATA 22 /**< Encrypted, Session Data, ASN.1, DER Encoded */ 96 #define STREAM_ENCRYPTED_FILE_GZIP_DATA 23 /**< Encrypted, compressed data - Deprecated */ 97 #define STREAM_ENCRYPTED_WIN32_GZIP_DATA 24 /**< Encrypted, compressed Win32 BackupRead data - Deprecated */ 98 #define STREAM_ENCRYPTED_MACOS_FORK_DATA 25 /**< Encrypted, uncompressed Mac resource fork */ 99 #define STREAM_PLUGIN_NAME 26 /**< Plugin "file" string */ 100 #define STREAM_PLUGIN_DATA 27 /**< Plugin specific data */ 101 #define STREAM_RESTORE_OBJECT 28 /**< Plugin restore object */ 102 103 /** 104 * Compressed streams. These streams can handle arbitrary compression algorithm data 105 * as an additional header is stored at the beginning of the stream. 106 * See stream_compressed_header definition for more details. 107 */ 108 #define STREAM_COMPRESSED_DATA 29 /**< Compressed file data */ 109 #define STREAM_SPARSE_COMPRESSED_DATA 30 /**< Sparse compressed data stream */ 110 #define STREAM_WIN32_COMPRESSED_DATA 31 /**< Compressed Win32 BackupRead data */ 111 #define STREAM_ENCRYPTED_FILE_COMPRESSED_DATA 32 /**< Encrypted, compressed data */ 112 #define STREAM_ENCRYPTED_WIN32_COMPRESSED_DATA 33 /**< Encrypted, compressed Win32 BackupRead data */ 113 114 #define STREAM_NDMP_SEPARATOR 999 /**< NDMP separator between multiple data streams of one job */ 115 116 /** 117 * The Stream numbers from 1000-1999 are reserved for ACL and extended attribute streams. 118 * Each different platform has its own stream id(s), if a platform supports multiple stream types 119 * it should supply different handlers for each type it supports and this should be called 120 * from the stream dispatch function. Currently in this reserved space we allocate the 121 * different acl streams from 1000 on and the different extended attributes streams from 122 * 1999 down. So the two naming spaces grow towards each other. 123 */ 124 #define STREAM_ACL_AIX_TEXT 1000 /**< AIX specific string representation from acl_get */ 125 #define STREAM_ACL_DARWIN_ACCESS_ACL 1001 /**< Darwin (OSX) specific acl_t string representation 126 * from acl_to_text (POSIX acl) 127 */ 128 #define STREAM_ACL_FREEBSD_DEFAULT_ACL 1002 /**< FreeBSD specific acl_t string representation 129 * from acl_to_text (POSIX acl) for default acls. 130 */ 131 #define STREAM_ACL_FREEBSD_ACCESS_ACL 1003 /**< FreeBSD specific acl_t string representation 132 * from acl_to_text (POSIX acl) for access acls. 133 */ 134 #define STREAM_ACL_HPUX_ACL_ENTRY 1004 /**< HPUX specific acl_entry string representation 135 * from acltostr (POSIX acl) 136 */ 137 #define STREAM_ACL_IRIX_DEFAULT_ACL 1005 /**< IRIX specific acl_t string representation 138 * from acl_to_text (POSIX acl) for default acls. 139 */ 140 #define STREAM_ACL_IRIX_ACCESS_ACL 1006 /**< IRIX specific acl_t string representation 141 * from acl_to_text (POSIX acl) for access acls. 142 */ 143 #define STREAM_ACL_LINUX_DEFAULT_ACL 1007 /**< Linux specific acl_t string representation 144 * from acl_to_text (POSIX acl) for default acls. 145 */ 146 #define STREAM_ACL_LINUX_ACCESS_ACL 1008 /**< Linux specific acl_t string representation 147 * from acl_to_text (POSIX acl) for access acls. 148 */ 149 #define STREAM_ACL_TRU64_DEFAULT_ACL 1009 /**< Tru64 specific acl_t string representation 150 * from acl_to_text (POSIX acl) for default acls. 151 */ 152 #define STREAM_ACL_TRU64_DEFAULT_DIR_ACL 1010 /**< Tru64 specific acl_t string representation 153 * from acl_to_text (POSIX acl) for default acls. 154 */ 155 #define STREAM_ACL_TRU64_ACCESS_ACL 1011 /**< Tru64 specific acl_t string representation 156 * from acl_to_text (POSIX acl) for access acls. 157 */ 158 #define STREAM_ACL_SOLARIS_ACLENT 1012 /**< Solaris specific aclent_t string representation 159 * from acltotext or acl_totext (POSIX acl) 160 */ 161 #define STREAM_ACL_SOLARIS_ACE 1013 /**< Solaris specific ace_t string representation from 162 * from acl_totext (NFSv4 or ZFS acl) 163 */ 164 #define STREAM_ACL_AFS_TEXT 1014 /**< AFS specific string representation from pioctl */ 165 #define STREAM_ACL_AIX_AIXC 1015 /**< AIX specific string representation from 166 * aclx_printStr (POSIX acl) 167 */ 168 #define STREAM_ACL_AIX_NFS4 1016 /**< AIX specific string representation from 169 * aclx_printStr (NFSv4 acl) 170 */ 171 #define STREAM_ACL_FREEBSD_NFS4_ACL 1017 /**< FreeBSD specific acl_t string representation 172 * from acl_to_text (NFSv4 or ZFS acl) 173 */ 174 #define STREAM_ACL_HURD_DEFAULT_ACL 1018 /**< GNU HURD specific acl_t string representation 175 * from acl_to_text (POSIX acl) for default acls. 176 */ 177 #define STREAM_ACL_HURD_ACCESS_ACL 1019 /**< GNU HURD specific acl_t string representation 178 * from acl_to_text (POSIX acl) for access acls. 179 */ 180 #define STREAM_ACL_PLUGIN 1020 /**< Plugin specific acl encoding */ 181 #define STREAM_XATTR_PLUGIN 1988 /**< Plugin specific extended attributes */ 182 #define STREAM_XATTR_HURD 1989 /**< GNU HURD specific extended attributes */ 183 #define STREAM_XATTR_IRIX 1990 /**< IRIX specific extended attributes */ 184 #define STREAM_XATTR_TRU64 1991 /**< TRU64 specific extended attributes */ 185 #define STREAM_XATTR_AIX 1992 /**< AIX specific extended attributes */ 186 #define STREAM_XATTR_OPENBSD 1993 /**< OpenBSD specific extended attributes */ 187 #define STREAM_XATTR_SOLARIS_SYS 1994 /**< Solaris specific extensible attributes or 188 * otherwise named extended system attributes. 189 */ 190 #define STREAM_XATTR_SOLARIS 1995 /**< Solaris specific extented attributes */ 191 #define STREAM_XATTR_DARWIN 1996 /**< Darwin (OSX) specific extended attributes */ 192 #define STREAM_XATTR_FREEBSD 1997 /**< FreeBSD specific extended attributes */ 193 #define STREAM_XATTR_LINUX 1998 /**< Linux specific extended attributes */ 194 #define STREAM_XATTR_NETBSD 1999 /**< NetBSD specific extended attributes */ 195 196 /** 197 * WARNING!!! do not define more than 2047 of these old types 198 */ 199 200 /* clang-format on */ 201 202 #endif /* BAREOS_INCLUDE_STREAMS_H_ */ 203