opendal/services/azblob/
backend.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use std::fmt::Debug;
19use std::fmt::Formatter;
20use std::sync::Arc;
21
22use base64::prelude::BASE64_STANDARD;
23use base64::Engine;
24use http::Response;
25use http::StatusCode;
26use log::debug;
27use reqsign::AzureStorageConfig;
28use reqsign::AzureStorageLoader;
29use reqsign::AzureStorageSigner;
30use sha2::Digest;
31use sha2::Sha256;
32
33use super::core::constants::X_MS_META_PREFIX;
34use super::core::constants::X_MS_VERSION_ID;
35use super::core::AzblobCore;
36use super::delete::AzblobDeleter;
37use super::error::parse_error;
38use super::lister::AzblobLister;
39use super::writer::AzblobWriter;
40use super::writer::AzblobWriters;
41use super::DEFAULT_SCHEME;
42use crate::raw::*;
43use crate::services::AzblobConfig;
44use crate::*;
45const AZBLOB_BATCH_LIMIT: usize = 256;
46
47impl From<AzureStorageConfig> for AzblobConfig {
48    fn from(value: AzureStorageConfig) -> Self {
49        Self {
50            endpoint: value.endpoint,
51            account_name: value.account_name,
52            account_key: value.account_key,
53            sas_token: value.sas_token,
54            ..Default::default()
55        }
56    }
57}
58
59impl Configurator for AzblobConfig {
60    type Builder = AzblobBuilder;
61
62    #[allow(deprecated)]
63    fn into_builder(self) -> Self::Builder {
64        AzblobBuilder {
65            config: self,
66
67            http_client: None,
68        }
69    }
70}
71
72#[doc = include_str!("docs.md")]
73#[derive(Default, Clone)]
74pub struct AzblobBuilder {
75    config: AzblobConfig,
76
77    #[deprecated(since = "0.53.0", note = "Use `Operator::update_http_client` instead")]
78    http_client: Option<HttpClient>,
79}
80
81impl Debug for AzblobBuilder {
82    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
83        let mut ds = f.debug_struct("AzblobBuilder");
84
85        ds.field("config", &self.config);
86
87        ds.finish()
88    }
89}
90
91impl AzblobBuilder {
92    /// Set root of this backend.
93    ///
94    /// All operations will happen under this root.
95    pub fn root(mut self, root: &str) -> Self {
96        self.config.root = if root.is_empty() {
97            None
98        } else {
99            Some(root.to_string())
100        };
101
102        self
103    }
104
105    /// Set container name of this backend.
106    pub fn container(mut self, container: &str) -> Self {
107        self.config.container = container.to_string();
108
109        self
110    }
111
112    /// Set endpoint of this backend
113    ///
114    /// Endpoint must be full uri, e.g.
115    ///
116    /// - Azblob: `https://accountname.blob.core.windows.net`
117    /// - Azurite: `http://127.0.0.1:10000/devstoreaccount1`
118    pub fn endpoint(mut self, endpoint: &str) -> Self {
119        if !endpoint.is_empty() {
120            // Trim trailing `/` so that we can accept `http://127.0.0.1:9000/`
121            self.config.endpoint = Some(endpoint.trim_end_matches('/').to_string());
122        }
123
124        self
125    }
126
127    /// Set account_name of this backend.
128    ///
129    /// - If account_name is set, we will take user's input first.
130    /// - If not, we will try to load it from environment.
131    pub fn account_name(mut self, account_name: &str) -> Self {
132        if !account_name.is_empty() {
133            self.config.account_name = Some(account_name.to_string());
134        }
135
136        self
137    }
138
139    /// Set account_key of this backend.
140    ///
141    /// - If account_key is set, we will take user's input first.
142    /// - If not, we will try to load it from environment.
143    pub fn account_key(mut self, account_key: &str) -> Self {
144        if !account_key.is_empty() {
145            self.config.account_key = Some(account_key.to_string());
146        }
147
148        self
149    }
150
151    /// Set encryption_key of this backend.
152    ///
153    /// # Args
154    ///
155    /// `v`: Base64-encoded key that matches algorithm specified in `encryption_algorithm`.
156    ///
157    /// # Note
158    ///
159    /// This function is the low-level setting for SSE related features.
160    ///
161    /// SSE related options should be set carefully to make them works.
162    /// Please use `server_side_encryption_with_*` helpers if even possible.
163    pub fn encryption_key(mut self, v: &str) -> Self {
164        if !v.is_empty() {
165            self.config.encryption_key = Some(v.to_string());
166        }
167
168        self
169    }
170
171    /// Set encryption_key_sha256 of this backend.
172    ///
173    /// # Args
174    ///
175    /// `v`: Base64-encoded SHA256 digest of the key specified in encryption_key.
176    ///
177    /// # Note
178    ///
179    /// This function is the low-level setting for SSE related features.
180    ///
181    /// SSE related options should be set carefully to make them works.
182    /// Please use `server_side_encryption_with_*` helpers if even possible.
183    pub fn encryption_key_sha256(mut self, v: &str) -> Self {
184        if !v.is_empty() {
185            self.config.encryption_key_sha256 = Some(v.to_string());
186        }
187
188        self
189    }
190
191    /// Set encryption_algorithm of this backend.
192    ///
193    /// # Args
194    ///
195    /// `v`: server-side encryption algorithm. (Available values: `AES256`)
196    ///
197    /// # Note
198    ///
199    /// This function is the low-level setting for SSE related features.
200    ///
201    /// SSE related options should be set carefully to make them works.
202    /// Please use `server_side_encryption_with_*` helpers if even possible.
203    pub fn encryption_algorithm(mut self, v: &str) -> Self {
204        if !v.is_empty() {
205            self.config.encryption_algorithm = Some(v.to_string());
206        }
207
208        self
209    }
210
211    /// Enable server side encryption with customer key.
212    ///
213    /// As known as: CPK
214    ///
215    /// # Args
216    ///
217    /// `key`: Base64-encoded SHA256 digest of the key specified in encryption_key.
218    ///
219    /// # Note
220    ///
221    /// Function that helps the user to set the server-side customer-provided encryption key, the key's SHA256, and the algorithm.
222    /// See [Server-side encryption with customer-provided keys (CPK)](https://learn.microsoft.com/en-us/azure/storage/blobs/encryption-customer-provided-keys)
223    /// for more info.
224    pub fn server_side_encryption_with_customer_key(mut self, key: &[u8]) -> Self {
225        // Only AES256 is supported for now
226        self.config.encryption_algorithm = Some("AES256".to_string());
227        self.config.encryption_key = Some(BASE64_STANDARD.encode(key));
228        self.config.encryption_key_sha256 =
229            Some(BASE64_STANDARD.encode(Sha256::digest(key).as_slice()));
230        self
231    }
232
233    /// Set sas_token of this backend.
234    ///
235    /// - If sas_token is set, we will take user's input first.
236    /// - If not, we will try to load it from environment.
237    ///
238    /// See [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview)
239    /// for more info.
240    pub fn sas_token(mut self, sas_token: &str) -> Self {
241        if !sas_token.is_empty() {
242            self.config.sas_token = Some(sas_token.to_string());
243        }
244
245        self
246    }
247
248    /// Specify the http client that used by this service.
249    ///
250    /// # Notes
251    ///
252    /// This API is part of OpenDAL's Raw API. `HttpClient` could be changed
253    /// during minor updates.
254    #[deprecated(since = "0.53.0", note = "Use `Operator::update_http_client` instead")]
255    #[allow(deprecated)]
256    pub fn http_client(mut self, client: HttpClient) -> Self {
257        self.http_client = Some(client);
258        self
259    }
260
261    /// Set maximum batch operations of this backend.
262    pub fn batch_max_operations(mut self, batch_max_operations: usize) -> Self {
263        self.config.batch_max_operations = Some(batch_max_operations);
264
265        self
266    }
267
268    /// from_connection_string will make a builder from connection string
269    ///
270    /// connection string looks like:
271    ///
272    /// ```txt
273    /// DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;
274    /// AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;
275    /// BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;
276    /// QueueEndpoint=http://127.0.0.1:10001/devstoreaccount1;
277    /// TableEndpoint=http://127.0.0.1:10002/devstoreaccount1;
278    /// ```
279    ///
280    /// Or
281    ///
282    /// ```txt
283    /// DefaultEndpointsProtocol=https;
284    /// AccountName=storagesample;
285    /// AccountKey=<account-key>;
286    /// EndpointSuffix=core.chinacloudapi.cn;
287    /// ```
288    ///
289    /// For reference: [Configure Azure Storage connection strings](https://learn.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string)
290    ///
291    /// # Note
292    ///
293    /// Connection strings can only configure the endpoint, account name and
294    /// authentication information. Users still need to configure container name.
295    pub fn from_connection_string(conn: &str) -> Result<Self> {
296        let config =
297            raw::azure_config_from_connection_string(conn, raw::AzureStorageService::Blob)?;
298
299        Ok(AzblobConfig::from(config).into_builder())
300    }
301}
302
303impl Builder for AzblobBuilder {
304    type Config = AzblobConfig;
305
306    fn build(self) -> Result<impl Access> {
307        debug!("backend build started: {:?}", &self);
308
309        let root = normalize_root(&self.config.root.unwrap_or_default());
310        debug!("backend use root {root}");
311
312        // Handle endpoint, region and container name.
313        let container = match self.config.container.is_empty() {
314            false => Ok(&self.config.container),
315            true => Err(Error::new(ErrorKind::ConfigInvalid, "container is empty")
316                .with_operation("Builder::build")
317                .with_context("service", Scheme::Azblob)),
318        }?;
319        debug!("backend use container {}", &container);
320
321        let endpoint = match &self.config.endpoint {
322            Some(endpoint) => Ok(endpoint.clone()),
323            None => Err(Error::new(ErrorKind::ConfigInvalid, "endpoint is empty")
324                .with_operation("Builder::build")
325                .with_context("service", Scheme::Azblob)),
326        }?;
327        debug!("backend use endpoint {}", &container);
328
329        let mut config_loader = AzureStorageConfig::default().from_env();
330
331        if let Some(v) = self
332            .config
333            .account_name
334            .clone()
335            .or_else(|| raw::azure_account_name_from_endpoint(endpoint.as_str()))
336        {
337            config_loader.account_name = Some(v);
338        }
339
340        if let Some(v) = self.config.account_key.clone() {
341            // Validate that account_key can be decoded as base64
342            if let Err(e) = BASE64_STANDARD.decode(&v) {
343                return Err(Error::new(
344                    ErrorKind::ConfigInvalid,
345                    format!("invalid account_key: cannot decode as base64: {e}"),
346                )
347                .with_operation("Builder::build")
348                .with_context("service", Scheme::Azblob)
349                .with_context("key", "account_key"));
350            }
351            config_loader.account_key = Some(v);
352        }
353
354        if let Some(v) = self.config.sas_token.clone() {
355            config_loader.sas_token = Some(v);
356        }
357
358        let encryption_key =
359            match &self.config.encryption_key {
360                None => None,
361                Some(v) => Some(build_header_value(v).map_err(|err| {
362                    err.with_context("key", "server_side_encryption_customer_key")
363                })?),
364            };
365
366        let encryption_key_sha256 = match &self.config.encryption_key_sha256 {
367            None => None,
368            Some(v) => Some(build_header_value(v).map_err(|err| {
369                err.with_context("key", "server_side_encryption_customer_key_sha256")
370            })?),
371        };
372
373        let encryption_algorithm = match &self.config.encryption_algorithm {
374            None => None,
375            Some(v) => {
376                if v == "AES256" {
377                    Some(build_header_value(v).map_err(|err| {
378                        err.with_context("key", "server_side_encryption_customer_algorithm")
379                    })?)
380                } else {
381                    return Err(Error::new(
382                        ErrorKind::ConfigInvalid,
383                        "encryption_algorithm value must be AES256",
384                    ));
385                }
386            }
387        };
388
389        let cred_loader = AzureStorageLoader::new(config_loader);
390
391        let signer = AzureStorageSigner::new();
392
393        Ok(AzblobBackend {
394            core: Arc::new(AzblobCore {
395                info: {
396                    let am = AccessorInfo::default();
397                    am.set_scheme(DEFAULT_SCHEME)
398                        .set_root(&root)
399                        .set_name(container)
400                        .set_native_capability(Capability {
401                            stat: true,
402                            stat_with_if_match: true,
403                            stat_with_if_none_match: true,
404
405                            read: true,
406
407                            read_with_if_match: true,
408                            read_with_if_none_match: true,
409                            read_with_override_content_disposition: true,
410                            read_with_if_modified_since: true,
411                            read_with_if_unmodified_since: true,
412
413                            write: true,
414                            write_can_append: true,
415                            write_can_empty: true,
416                            write_can_multi: true,
417                            write_with_cache_control: true,
418                            write_with_content_type: true,
419                            write_with_if_not_exists: true,
420                            write_with_if_none_match: true,
421                            write_with_user_metadata: true,
422
423                            delete: true,
424                            delete_max_size: Some(AZBLOB_BATCH_LIMIT),
425
426                            copy: true,
427                            copy_with_if_not_exists: true,
428
429                            list: true,
430                            list_with_recursive: true,
431
432                            presign: self.config.sas_token.is_some(),
433                            presign_stat: self.config.sas_token.is_some(),
434                            presign_read: self.config.sas_token.is_some(),
435                            presign_write: self.config.sas_token.is_some(),
436
437                            shared: true,
438
439                            ..Default::default()
440                        });
441
442                    // allow deprecated api here for compatibility
443                    #[allow(deprecated)]
444                    if let Some(client) = self.http_client {
445                        am.update_http_client(|_| client);
446                    }
447
448                    am.into()
449                },
450                root,
451                endpoint,
452                encryption_key,
453                encryption_key_sha256,
454                encryption_algorithm,
455                container: self.config.container.clone(),
456
457                loader: cred_loader,
458                signer,
459            }),
460        })
461    }
462}
463
464/// Backend for azblob services.
465#[derive(Debug, Clone)]
466pub struct AzblobBackend {
467    core: Arc<AzblobCore>,
468}
469
470impl Access for AzblobBackend {
471    type Reader = HttpBody;
472    type Writer = AzblobWriters;
473    type Lister = oio::PageLister<AzblobLister>;
474    type Deleter = oio::BatchDeleter<AzblobDeleter>;
475
476    fn info(&self) -> Arc<AccessorInfo> {
477        self.core.info.clone()
478    }
479
480    async fn stat(&self, path: &str, args: OpStat) -> Result<RpStat> {
481        let resp = self.core.azblob_get_blob_properties(path, &args).await?;
482
483        let status = resp.status();
484
485        match status {
486            StatusCode::OK => {
487                let headers = resp.headers();
488                let mut meta = parse_into_metadata(path, headers)?;
489                if let Some(version_id) = parse_header_to_str(headers, X_MS_VERSION_ID)? {
490                    meta.set_version(version_id);
491                }
492
493                let user_meta = parse_prefixed_headers(headers, X_MS_META_PREFIX);
494                if !user_meta.is_empty() {
495                    meta = meta.with_user_metadata(user_meta);
496                }
497
498                Ok(RpStat::new(meta))
499            }
500            _ => Err(parse_error(resp)),
501        }
502    }
503
504    async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> {
505        let resp = self.core.azblob_get_blob(path, args.range(), &args).await?;
506
507        let status = resp.status();
508        match status {
509            StatusCode::OK | StatusCode::PARTIAL_CONTENT => Ok((RpRead::new(), resp.into_body())),
510            _ => {
511                let (part, mut body) = resp.into_parts();
512                let buf = body.to_buffer().await?;
513                Err(parse_error(Response::from_parts(part, buf)))
514            }
515        }
516    }
517
518    async fn write(&self, path: &str, args: OpWrite) -> Result<(RpWrite, Self::Writer)> {
519        let w = AzblobWriter::new(self.core.clone(), args.clone(), path.to_string());
520        let w = if args.append() {
521            AzblobWriters::Two(oio::AppendWriter::new(w))
522        } else {
523            AzblobWriters::One(oio::BlockWriter::new(
524                self.core.info.clone(),
525                w,
526                args.concurrent(),
527            ))
528        };
529
530        Ok((RpWrite::default(), w))
531    }
532
533    async fn delete(&self) -> Result<(RpDelete, Self::Deleter)> {
534        Ok((
535            RpDelete::default(),
536            oio::BatchDeleter::new(AzblobDeleter::new(self.core.clone())),
537        ))
538    }
539
540    async fn list(&self, path: &str, args: OpList) -> Result<(RpList, Self::Lister)> {
541        let l = AzblobLister::new(
542            self.core.clone(),
543            path.to_string(),
544            args.recursive(),
545            args.limit(),
546        );
547
548        Ok((RpList::default(), oio::PageLister::new(l)))
549    }
550
551    async fn copy(&self, from: &str, to: &str, args: OpCopy) -> Result<RpCopy> {
552        let resp = self.core.azblob_copy_blob(from, to, args).await?;
553
554        let status = resp.status();
555
556        match status {
557            StatusCode::ACCEPTED => Ok(RpCopy::default()),
558            _ => Err(parse_error(resp)),
559        }
560    }
561
562    async fn presign(&self, path: &str, args: OpPresign) -> Result<RpPresign> {
563        let req = match args.operation() {
564            PresignOperation::Stat(v) => self.core.azblob_head_blob_request(path, v),
565            PresignOperation::Read(v) => {
566                self.core
567                    .azblob_get_blob_request(path, BytesRange::default(), v)
568            }
569            PresignOperation::Write(_) => {
570                self.core
571                    .azblob_put_blob_request(path, None, &OpWrite::default(), Buffer::new())
572            }
573            PresignOperation::Delete(_) => Err(Error::new(
574                ErrorKind::Unsupported,
575                "operation is not supported",
576            )),
577        };
578
579        let mut req = req?;
580
581        self.core.sign_query(&mut req).await?;
582
583        let (parts, _) = req.into_parts();
584
585        Ok(RpPresign::new(PresignedRequest::new(
586            parts.method,
587            parts.uri,
588            parts.headers,
589        )))
590    }
591}
opendal/services/azblob/backend.rs

opendal/services/azblob/
backend.rs
