1 //! Backup reader/restore protocol (HTTP2 upgrade)
3 use anyhow
::{bail, format_err, Error}
;
5 use hyper
::header
::{self, HeaderValue, UPGRADE}
;
6 use hyper
::http
::request
::Parts
;
7 use hyper
::{Body, Response, Request, StatusCode}
;
14 list_subdirs_api_method
,
30 use pbs_tools
::fs
::lock_dir_noblock_shared
;
31 use pbs_datastore
::PROXMOX_BACKUP_READER_PROTOCOL_ID_V1
;
60 PRIV_DATASTORE_BACKUP
,
62 cached_user_info
::CachedUserInfo
,
69 pub const ROUTER
: Router
= Router
::new()
70 .upgrade(&API_METHOD_UPGRADE_BACKUP
);
73 pub const API_METHOD_UPGRADE_BACKUP
: ApiMethod
= ApiMethod
::new(
74 &ApiHandler
::AsyncHttp(&upgrade_to_backup_reader_protocol
),
76 concat
!("Upgraded to backup protocol ('", PROXMOX_BACKUP_READER_PROTOCOL_ID_V1
!(), "')."),
78 ("store", false, &DATASTORE_SCHEMA
),
79 ("backup-type", false, &BACKUP_TYPE_SCHEMA
),
80 ("backup-id", false, &BACKUP_ID_SCHEMA
),
81 ("backup-time", false, &BACKUP_TIME_SCHEMA
),
82 ("debug", true, &BooleanSchema
::new("Enable verbose debug logging.").schema()),
86 // Note: parameter 'store' is no uri parameter, so we need to test inside function body
87 Some("The user needs Datastore.Read privilege on /datastore/{store}."),
91 fn upgrade_to_backup_reader_protocol(
96 rpcenv
: Box
<dyn RpcEnvironment
>,
97 ) -> ApiResponseFuture
{
100 let debug
= param
["debug"].as_bool().unwrap_or(false);
102 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
103 let store
= tools
::required_string_param(¶m
, "store")?
.to_owned();
105 let user_info
= CachedUserInfo
::new()?
;
106 let privs
= user_info
.lookup_privs(&auth_id
, &["datastore", &store
]);
108 let priv_read
= privs
& PRIV_DATASTORE_READ
!= 0;
109 let priv_backup
= privs
& PRIV_DATASTORE_BACKUP
!= 0;
111 // priv_backup needs owner check further down below!
112 if !priv_read
&& !priv_backup
{
113 bail
!("no permissions on /datastore/{}", store
);
116 let datastore
= DataStore
::lookup_datastore(&store
)?
;
118 let backup_type
= tools
::required_string_param(¶m
, "backup-type")?
;
119 let backup_id
= tools
::required_string_param(¶m
, "backup-id")?
;
120 let backup_time
= tools
::required_integer_param(¶m
, "backup-time")?
;
122 let protocols
= parts
125 .ok_or_else(|| format_err
!("missing Upgrade header"))?
128 if protocols
!= PROXMOX_BACKUP_READER_PROTOCOL_ID_V1
!() {
129 bail
!("invalid protocol name");
132 if parts
.version
>= http
::version
::Version
::HTTP_2
{
133 bail
!("unexpected http version '{:?}' (expected version < 2)", parts
.version
);
136 let env_type
= rpcenv
.env_type();
138 let backup_dir
= BackupDir
::new(backup_type
, backup_id
, backup_time
)?
;
140 let owner
= datastore
.get_owner(backup_dir
.group())?
;
141 let correct_owner
= owner
== auth_id
143 && Authid
::from(owner
.user().clone()) == auth_id
);
145 bail
!("backup owner check failed!");
149 let _guard
= lock_dir_noblock_shared(
150 &datastore
.snapshot_path(&backup_dir
),
152 "locked by another operation")?
;
154 let path
= datastore
.base_path();
156 //let files = BackupInfo::list_files(&path, &backup_dir)?;
158 let worker_id
= format
!("{}:{}/{}/{:08X}", store
, backup_type
, backup_id
, backup_dir
.backup_time());
160 WorkerTask
::spawn("reader", Some(worker_id
), auth_id
.clone(), true, move |worker
| async
move {
163 let mut env
= ReaderEnvironment
::new(
173 env
.log(format
!("starting new backup reader datastore '{}': {:?}", store
, path
));
175 let service
= H2Service
::new(env
.clone(), worker
.clone(), &READER_API_ROUTER
, debug
);
177 let mut abort_future
= worker
.abort_future()
178 .map(|_
| Err(format_err
!("task aborted")));
180 let env2
= env
.clone();
181 let req_fut
= async
move {
182 let conn
= hyper
::upgrade
::on(Request
::from_parts(parts
, req_body
)).await?
;
183 env2
.debug("protocol upgrade done");
185 let mut http
= hyper
::server
::conn
::Http
::new();
186 http
.http2_only(true);
187 // increase window size: todo - find optiomal size
188 let window_size
= 32*1024*1024; // max = (1 << 31) - 2
189 http
.http2_initial_stream_window_size(window_size
);
190 http
.http2_initial_connection_window_size(window_size
);
191 http
.http2_max_frame_size(4*1024*1024);
193 http
.serve_connection(conn
, service
)
194 .map_err(Error
::from
).await
198 req
= req_fut
.fuse() => req?
,
199 abort
= abort_future
=> abort?
,
202 env
.log("reader finished successfully");
207 let response
= Response
::builder()
208 .status(StatusCode
::SWITCHING_PROTOCOLS
)
209 .header(UPGRADE
, HeaderValue
::from_static(PROXMOX_BACKUP_READER_PROTOCOL_ID_V1
!()))
210 .body(Body
::empty())?
;
216 const READER_API_SUBDIRS
: SubdirMap
= &[
218 "chunk", &Router
::new()
219 .download(&API_METHOD_DOWNLOAD_CHUNK
)
222 "download", &Router
::new()
223 .download(&API_METHOD_DOWNLOAD_FILE
)
226 "speedtest", &Router
::new()
227 .download(&API_METHOD_SPEEDTEST
)
231 pub const READER_API_ROUTER
: Router
= Router
::new()
232 .get(&list_subdirs_api_method
!(READER_API_SUBDIRS
))
233 .subdirs(READER_API_SUBDIRS
);
236 pub const API_METHOD_DOWNLOAD_FILE
: ApiMethod
= ApiMethod
::new(
237 &ApiHandler
::AsyncHttp(&download_file
),
239 "Download specified file.",
241 ("file-name", false, &crate::api2
::types
::BACKUP_ARCHIVE_NAME_SCHEMA
),
251 rpcenv
: Box
<dyn RpcEnvironment
>,
252 ) -> ApiResponseFuture
{
255 let env
: &ReaderEnvironment
= rpcenv
.as_ref();
257 let file_name
= tools
::required_string_param(¶m
, "file-name")?
.to_owned();
259 let mut path
= env
.datastore
.base_path();
260 path
.push(env
.backup_dir
.relative_path());
261 path
.push(&file_name
);
263 env
.log(format
!("download {:?}", path
.clone()));
265 let index
: Option
<Box
<dyn IndexFile
+ Send
>> = match archive_type(&file_name
)?
{
266 ArchiveType
::FixedIndex
=> {
267 let index
= env
.datastore
.open_fixed_reader(&path
)?
;
268 Some(Box
::new(index
))
270 ArchiveType
::DynamicIndex
=> {
271 let index
= env
.datastore
.open_dynamic_reader(&path
)?
;
272 Some(Box
::new(index
))
277 if let Some(index
) = index
{
278 env
.log(format
!("register chunks in '{}' as downloadable.", file_name
));
280 for pos
in 0..index
.index_count() {
281 let info
= index
.chunk_info(pos
).unwrap();
282 env
.register_chunk(info
.digest
);
286 helpers
::create_download_response(path
).await
291 pub const API_METHOD_DOWNLOAD_CHUNK
: ApiMethod
= ApiMethod
::new(
292 &ApiHandler
::AsyncHttp(&download_chunk
),
294 "Download specified chunk.",
296 ("digest", false, &CHUNK_DIGEST_SCHEMA
),
306 rpcenv
: Box
<dyn RpcEnvironment
>,
307 ) -> ApiResponseFuture
{
310 let env
: &ReaderEnvironment
= rpcenv
.as_ref();
312 let digest_str
= tools
::required_string_param(¶m
, "digest")?
;
313 let digest
= proxmox
::tools
::hex_to_digest(digest_str
)?
;
315 if !env
.check_chunk_access(digest
) {
316 env
.log(format
!("attempted to download chunk {} which is not in registered chunk list", digest_str
));
317 return Err(http_err
!(UNAUTHORIZED
, "download chunk {} not allowed", digest_str
));
320 let (path
, _
) = env
.datastore
.chunk_path(&digest
);
321 let path2
= path
.clone();
323 env
.debug(format
!("download chunk {:?}", path
));
325 let data
= pbs_runtime
::block_in_place(|| std
::fs
::read(path
))
326 .map_err(move |err
| http_err
!(BAD_REQUEST
, "reading file {:?} failed: {}", path2
, err
))?
;
328 let body
= Body
::from(data
);
330 // fixme: set other headers ?
331 Ok(Response
::builder()
332 .status(StatusCode
::OK
)
333 .header(header
::CONTENT_TYPE
, "application/octet-stream")
340 fn download_chunk_old(
345 rpcenv: Box<dyn RpcEnvironment>,
346 ) -> Result<ApiResponseFuture, Error> {
348 let env: &ReaderEnvironment = rpcenv.as_ref();
349 let env2 = env.clone();
351 let digest_str = tools::required_string_param(¶m, "digest")?;
352 let digest = proxmox::tools::hex_to_digest(digest_str)?;
354 let (path, _) = env.datastore.chunk_path(&digest);
356 let path2 = path.clone();
357 let path3 = path.clone();
359 let response_future = tokio::fs::File::open(path)
360 .map_err(move |err| http_err!(BAD_REQUEST, "open file {:?} failed: {}", path2, err))
361 .and_then(move |file| {
362 env2.debug(format!("download chunk {:?}", path3));
363 let payload = tokio_util::codec::FramedRead::new(file, tokio_util::codec::BytesCodec::new())
364 .map_ok(|bytes| hyper::body::Bytes::from(bytes.freeze()));
366 let body = Body::wrap_stream(payload);
368 // fixme: set other headers ?
369 futures::future::ok(Response::builder()
370 .status(StatusCode::OK)
371 .header(header::CONTENT_TYPE, "application/octet-stream")
376 Ok(Box::new(response_future))
380 pub const API_METHOD_SPEEDTEST
: ApiMethod
= ApiMethod
::new(
381 &ApiHandler
::AsyncHttp(&speedtest
),
382 &ObjectSchema
::new("Test 1M block download speed.", &[])
390 _rpcenv
: Box
<dyn RpcEnvironment
>,
391 ) -> ApiResponseFuture
{
393 let buffer
= vec
![65u8; 1024*1024]; // nonsense [A,A,A...]
395 let body
= Body
::from(buffer
);
397 let response
= Response
::builder()
398 .status(StatusCode
::OK
)
399 .header(header
::CONTENT_TYPE
, "application/octet-stream")
403 future
::ok(response
).boxed()