obs_sdk/
lib.rs

1//! # 使用说明
2//! 
3//! ## 1. 列举桶内对象列表
4//! 
5//! ```rust
6//! use obs_sdk::ObsClient;
7//! 
8//! static ENDPOINT: &str = "obs.cn-north-4.myhuaweicloud.com";
9//! static AK: &str = "YOUR_AK";
10//! static SK: &str = "YOUR_SK";
11//! static BUCKET_NAME: &str = "bucket_name";
12//! 
13//! #[tokio::test]
14//! async fn test_list_prefix() -> Result<(), Box<dyn std::error::Error>> {
15//!     let client = ObsClient {
16//!         endpoint: ENDPOINT.to_string(),
17//!         ak: AK.to_string(),
18//!         sk: SK.to_string(),
19//!         bucket: BUCKET_NAME.to_string(),
20//!     };
21//!     let res = client.list("tmp").await?;
22//!     println!("{:?}", res);
23//!     Ok(())
24//! }
25//! ```
26//! 
27//! ## 2. 上传对象到桶
28//! 
29//! ```rust
30//! use obs_sdk::ObsClient;
31//! 
32//! static ENDPOINT: &str = "obs.cn-north-4.myhuaweicloud.com";
33//! static AK: &str = "YOUR_AK";
34//! static SK: &str = "YOUR_SK";
35//! static BUCKET_NAME: &str = "bucket_name";
36//! 
37//! #[tokio::test]
38//! async fn test_upload_object() -> Result<(), Box<dyn std::error::Error>> {
39//!     let client = ObsClient {
40//!         endpoint: ENDPOINT.to_string(),
41//!         ak: AK.to_string(),
42//!         sk: SK.to_string(),
43//!         bucket: BUCKET_NAME.to_string(),
44//!     };
45//!     let res = client.upload_file("tmp_cargo.txt", "Cargo.txt").await?;
46//!     println!("{:?}", res);
47//!     Ok(())
48//! }
49//! ```
50//! 
51//! ## 3. 下载对象到本地目录
52//! 
53//! ```rust
54//! use obs_sdk::ObsClient;
55//! 
56//! static ENDPOINT: &str = "obs.cn-north-4.myhuaweicloud.com";
57//! static AK: &str = "YOUR_AK";
58//! static SK: &str = "YOUR_SK";
59//! static BUCKET_NAME: &str = "bucket_name";
60//! 
61//! #[tokio::test]
62//! async fn test_download_file02() -> Result<(), Box<dyn std::error::Error>> {
63//!     let client = ObsClient {
64//!         endpoint: ENDPOINT.to_string(),
65//!         ak: AK.to_string(),
66//!         sk: SK.to_string(),
67//!         bucket: BUCKET_NAME.to_string(),
68//!     };
69//!     let res = client.download_file("2hls_stutter-10.mp4", "video/2hls_stutter-10.mp4", false).await;
70//!     res
71//! }
72//! ```
73//! 
74//! ## 4. 下载对象为字节内容
75//! 
76//! ```rust
77//! use obs_sdk::ObsClient;
78//! 
79//! static ENDPOINT: &str = "obs.cn-north-4.myhuaweicloud.com";
80//! static AK: &str = "YOUR_AK";
81//! static SK: &str = "YOUR_SK";
82//! static BUCKET_NAME: &str = "bucket_name";
83//! 
84//! #[tokio::test]
85//! async fn test_download_file01() -> Result<(), Box<dyn std::error::Error>> {
86//!     let client = ObsClient {
87//!         endpoint: ENDPOINT.to_string(),
88//!         ak: AK.to_string(),
89//!         sk: SK.to_string(),
90//!         bucket: BUCKET_NAME.to_string(),
91//!     };
92//!     let data = client.download_object("2hls_stutter-10.mp4").await?;
93//!     let file_path = Path::new("output.mp4");
94//!     match fs::write(file_path, data) {
95//!         Ok(_) => println!("文件保存成功{:?}", file_path),
96//!         Err(e) => eprintln!("文件保存失败:{}", e)
97//!     }
98//!     Ok(())
99//! }
100//! ```
101//! 
102//! ## 5. url鉴权
103//! 
104//! ```rust
105//! use obs_sdk::ObsClient;
106//!
107//! static ENDPOINT: &str = "obs.cn-north-4.myhuaweicloud.com";
108//! static AK: &str = "YOUR_AK";
109//! static SK: &str = "YOUR_SK";
110//! static BUCKET_NAME: &str = "bucket_name";
111//! 
112//! #[test]
113//! fn test_url_sign() -> Result<(), Box<dyn std::error::Error>> {
114//!     let client = ObsClient {
115//!         endpoint: ENDPOINT.to_string(),
116//!         ak: AK.to_string(),
117//!         sk: SK.to_string(),
118//!         bucket: BUCKET_NAME.to_string(),
119//!     };
120//!     let sign_url = client.url_sign("https://ranfs.obs.cn-north-4.myhuaweicloud.com/tmp_cargo.txt")?;
121//!     println!("sign_url = {}", sign_url);
122//!     Ok(())
123//! }
124//! ```
125//! 
126mod utils;
127mod algorithm;
128
129use algorithm::HmacSha1;
130use std::fs;
131use std::path::Path;
132use std::io::{Error, ErrorKind};
133use serde::{Serialize, Deserialize};
134use regex::Regex;
135use std::vec::Vec;
136use url::{Url, form_urlencoded};
137use chrono::Local;
138use reqwest::StatusCode;
139
140/// 华为云OBS客户端
141/// 
142pub struct ObsClient {
143    pub endpoint: String,
144    pub ak: String,
145    pub sk: String,
146    pub bucket: String,
147}
148
149impl ObsClient {
150
151    /// 列举指定前缀开头的所有对象元数据，方法内部会构造http请求：
152    /// ```plain
153    /// GET / HTTP/1.1
154    /// Host: bucketname.obs.cn-north-4.myhuaweicloud.com
155    /// Date: date
156    /// Authorization: authorization
157    /// ```
158    /// 
159    pub async fn list(&self, prefix: &str) -> Result<Vec<ObjectMeta>, Box<dyn std::error::Error>> {
160        // 构造完整的url地址
161        let url = format!("https://{}.{}/?prefix={}", self.bucket, self.endpoint, prefix);
162
163        //  获取GMT格式的时间字符串
164        let date = utils::now_str_gmt();
165
166        // 创建HmacSha1对象
167        let hmacsha1 = HmacSha1();
168
169        // 构造签名用的原始字符串
170        let string_to_sign = hmacsha1.header_string_to_sign("GET", "", "", &date, "",  &format!("/{}/", self.bucket));
171
172        // 根据原始字符串+ak，获取header签名
173        let signature = hmacsha1.sign_to_base64string(&string_to_sign, &self.sk);
174
175        // 构造请求头Authorization的值
176        let authorization = format!("OBS {}:{}", self.ak, signature);
177        // 构造http请求
178        let client = reqwest::Client::new();
179        let res = client.get(url)
180            .header("Date", &date)
181            .header("Authorization", &authorization)
182            .send()
183            .await?;
184
185        // 如果请求成功，则返回字节内容
186        if res.status().is_success() {
187            let xml_content_string = res.text().await?;
188            let results = XmlParser::new(&xml_content_string).parse();
189            return Ok(results);
190        }
191
192        Err(Box::new(Error::new(ErrorKind::Other, format!("请求失败，状态码={}", res.status()))))
193    }
194
195    /// 上传对象
196    /// 
197    /// 方法内部构建请求
198    /// ```plain
199    /// PUT /object01 HTTP/1.1
200    /// User-Agent: curl/7.29.0
201    /// Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
202    /// Accept: */*
203    /// Date: WED, 01 Jul 2015 04:11:15 GMT
204    /// Authorization: OBS H4IPJX0TQTHTHEBQQCEC:gYqplLq30dEX7GMi2qFWyjdFsyw=
205    /// Content-Length: 10240
206    /// Expect: 100-continue
207    /// 
208    /// [1024 Byte data content]
209    /// ```
210    /// 
211    pub async fn upload_object(&self, obj_key: &str, data: Vec<u8>) -> Result<(), Box<dyn std::error::Error>> {
212        // 构造完整的url地址
213        let url = format!("https://{}.{}/{}", self.bucket, self.endpoint, obj_key);
214
215        let md5_string = utils::base64_md5_str(&data);
216
217        //  获取GMT格式的时间字符串
218        let date = utils::now_str_gmt();
219
220        // 创建HmacSha1对象
221        let hmacsha1 = HmacSha1();
222
223        let file_type = &utils::get_mime_type_from_extension(obj_key)
224            .expect("资源对应类型暂不支持上传，请在方法get_mime_type_from_extension中添加文件类型");
225
226        // 构造签名用的原始字符串
227        let string_to_sign = hmacsha1.header_string_to_sign("PUT", &md5_string, file_type, &date, "",  &format!("/{}/{}", self.bucket, obj_key));
228
229        // 根据原始字符串+ak，获取header签名
230        let signature = hmacsha1.sign_to_base64string(&string_to_sign, &self.sk);
231
232        // 构造请求头Authorization的值
233        let authorization = format!("OBS {}:{}", self.ak, signature);
234
235        // 构造http请求
236        let client = reqwest::Client::new();
237        let res = client.put(url)
238            .header("Content-MD5", &md5_string)
239            .header("Date", &date)
240            .header("Content-Type", file_type)
241            .header("Content-Length", data.len())
242            .header("Authorization", authorization)
243            .body(data)
244            .send()
245            .await;
246
247        let res = match res {
248            Ok(response) => response,
249            Err(e) => {
250                return Err(Box::new(std::io::Error::new(std::io::ErrorKind::Other, e)));
251            },
252        };
253        let _status: StatusCode = res.status();
254
255        Ok(())
256
257    }
258
259    /// 上传文件
260    pub async fn upload_file(&self, obj_key: &str, file_path: &str) -> Result<(), Box<dyn std::error::Error>> {
261        let data = fs::read(file_path)?;
262        self.upload_object(obj_key, data).await
263    }
264
265    /// 下载对象，方法内部会构造http请求：
266    /// ```plain
267    /// GET /{obj_key} HTTP/1.1
268    /// Host: {bucket}.obs.cn-north-4.myhuaweicloud.com
269    /// Date: {date}
270    /// ```
271    /// 
272    pub async fn download_object(&self, obj_key: &str) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
273
274        // 构造完整的url地址
275        let url = format!("https://{}.{}/{}", self.bucket, self.endpoint, obj_key);
276
277        //  获取GMT格式的时间字符串
278        let date = utils::now_str_gmt();
279
280        // 创建HmacSha1对象
281        let hmacsha1 = HmacSha1();
282
283        // 构造签名用的原始字符串
284        let string_to_sign = hmacsha1.header_string_to_sign("GET", "", "", &date, "",  &format!("/{}/{}", self.bucket, obj_key));
285
286        // 根据原始字符串+ak，获取header签名
287        let signature = hmacsha1.sign_to_base64string(&string_to_sign, &self.sk);
288
289        // 构造请求头Authorization的值
290        let authorization = format!("OBS {}:{}", self.ak, signature);
291
292        // 构造http请求
293        let client = reqwest::Client::new();
294        let res = client.get(url)
295            .header("Authorization", &authorization)
296            .header("Date", &date)
297            .send()
298            .await?;
299
300        // 如果请求成功，则返回字节内容
301        if res.status().is_success() {
302            return Ok(res.bytes().await?.to_vec());
303        }
304        
305        Err(Box::new(Error::new(ErrorKind::Other, format!("请求失败，状态码={}", res.status()))))
306    }
307
308    /// 删除obs上的对象
309    pub async fn delete_object(&self, obj_key: &str) -> Result<(), Box<dyn std::error::Error>> {
310        // 构造完整的url地址
311        let url = format!("https://{}.{}/{}", self.bucket, self.endpoint, obj_key);
312
313        let md5_string = "";
314
315        //  获取GMT格式的时间字符串
316        let date = utils::now_str_gmt();
317
318        // 创建HmacSha1对象
319        let hmacsha1 = HmacSha1();
320
321        // 构造签名用的原始字符串
322        let string_to_sign = hmacsha1.header_string_to_sign("DELETE", &md5_string, "", &date, "",  &format!("/{}/{}", self.bucket, obj_key));
323
324        // 根据原始字符串+ak，获取header签名
325        let signature = hmacsha1.sign_to_base64string(&string_to_sign, &self.sk);
326
327        // 构造请求头Authorization的值
328        let authorization = format!("OBS {}:{}", self.ak, signature);
329
330        // 构造http请求
331        let client = reqwest::Client::new();
332        let res = client.delete(url)
333            .header("Date", &date)
334            .header("Authorization", authorization)
335            .send()
336            .await;
337
338        let res = match res {
339            Ok(response) => response,
340            Err(e) => {
341                return Err(Box::new(std::io::Error::new(std::io::ErrorKind::Other, e)));
342            },
343        };
344        let status = res.status();
345        println!("status = {}, {}", status, res.text_with_charset("utf-8").await?);
346
347        Ok(())
348    }
349
350    /// 下载文件，并指定本地保存用的文件路径
351    /// 
352    /// # 参数
353    /// 
354    /// `overwrite` - 是否覆盖，true，当文件存在时，覆盖文件，false，当文件存在时，不覆盖文件
355    /// 
356    pub async fn download_file(&self, obj_key: &str, file_path: &str, overwrite: bool) -> Result<(), Box<dyn std::error::Error>> {
357        let file_path = Path::new(file_path);
358
359        // 判断文件是否存在，如果存在，不做任何操作
360        if file_path.exists() && !overwrite {
361            return Err(Box::new(Error::new(ErrorKind::AlreadyExists, "文件已存在，请删除文件或设置覆盖参数")));
362        }
363
364        // 根据父目录是否存在，选择性创建父目录
365        let parent = file_path.parent().unwrap();
366        if !parent.exists() {
367            fs::create_dir_all(&parent)?;
368        }
369
370        // 下载文件，得到原始文件字节内容
371        let data = self.download_object(obj_key).await?;
372        
373        // 保存文件
374        fs::write(file_path, data)?;
375        Ok(())
376    }
377
378    pub fn url_sign(&self, url_str: &str) -> Result<String, Box<dyn std::error::Error>> {
379        let obs_object_url = Url::parse(url_str)?;
380        let resource_part = obs_object_url.path();
381        let host = obs_object_url.host().unwrap();
382        let domain = match host {
383            url::Host::Domain(domain) => domain.to_string(),
384            _ => format!("{}.{}", self.bucket, self.endpoint)
385        };
386        let parts: Vec<&str> = domain.split(".").collect();
387        let bucket_name = parts[0];
388
389        let timestamp = utils::timestamp(Local::now(), 3600*2);
390
391        //  获取GMT格式的时间字符串
392        let expires = format!("{}", timestamp);
393
394        // 创建HmacSha1对象
395        let hmacsha1 = HmacSha1();
396
397        // 构造签名用的原始字符串
398        let string_to_sign = hmacsha1.url_string_to_sign("GET", "", "", &expires, "",  &format!("/{}{}", bucket_name, resource_part));
399
400        // 根据原始字符串+ak，获取header签名
401        let signature = hmacsha1.sign_to_base64string(&string_to_sign, &self.sk);
402        let signature = form_urlencoded::byte_serialize(signature.as_bytes()).collect::<String>();
403
404        // 构造url
405        let sign_url = format!("{}?AccessKeyId={}&Expires={}&Signature={}", url_str, self.ak, expires, signature);
406        Ok(sign_url)
407    }
408
409}
410
411
412/// obs对象的元数据信息
413/// 
414/// 这个结构体用于表示 OBS 对象的元数据，包含对象的各种属性，如名称、修改时间、内容标识、大小以及存储类型。
415#[derive(Serialize, Deserialize, Debug)]
416pub struct ObjectMeta {
417
418    /// 对象名
419    /// 
420    /// 唯一标识 OBS 存储中的对象
421    pub key: String,
422
423    /// 对象最近一次被修改的时间（UTC时间）
424    /// 
425    /// 该时间戳表示对象在 OBS 存储中最后一次被修改的时刻，采用 UTC 时间格式。
426    pub last_modified: String,
427
428    /// 对象的base64编码的128位MD5摘要
429    /// 
430    /// 这个 ETag 值是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。
431    pub etag: String,
432
433    /// 对象的字节数
434    /// 
435    /// 表示对象在存储中占用的字节大小
436    pub size: u64,
437
438    /// 对象的存储类型：STANDARD，WARM，COLD，DEEP_ARCHIVE
439    /// 
440    /// 不同的存储类型对应不同的存储成本和访问性能，用户可以根据对象的访问频率等因素选择合适的存储类型
441    pub storage_class: String,
442}
443
444/// XML解析器
445/// 
446/// 用于解析XML格式的响应数据，目前这里面针对obs的接口“列举桶内对象”的响应结果进行解析，没有进行通用的xml解析，其不能作为通用工具使用
447struct XmlParser { 
448    xml: String,
449}
450
451
452impl XmlParser {
453    fn new(xml: &str) -> Self {
454        XmlParser { xml: xml.to_string() }
455    }
456
457    /// 解析obs接口“列举桶内对象”的响应结果
458    /// 
459    /// 该内部采用正则表达式进行解析，因此依赖外部的regex库
460    fn parse(&self) -> Vec<ObjectMeta> {
461        let xml = &self.xml;
462
463        // 定义解析需要使用的正则表达式
464        let contents_re = Regex::new(r#"<Contents>(.*?)</Contents>"#).unwrap();
465        let key_regex = Regex::new(r#"<Key>(.*?)</Key>"#).unwrap();
466        let last_modified_regex = Regex::new(r#"<LastModified>(.*?)</LastModified>"#).unwrap();
467        let etag_regex = Regex::new(r#"<ETag>(.*?)</ETag>"#).unwrap();
468        let size_regex = Regex::new(r#"<Size>(.*?)</Size>"#).unwrap();
469        let storage_class_regex = Regex::new(r#"<StorageClass>(.*?)</StorageClass>"#).unwrap();
470
471
472        // 解析Contents标签内的数据
473        let mut contents_vec = Vec::new();
474        for captures in contents_re.captures_iter(xml) {
475            let inner_content = &captures[1];
476
477            let key = key_regex.captures(inner_content).map(|cap| cap[1].to_string()).unwrap_or_default();
478            let last_modified = last_modified_regex.captures(inner_content).map(|cap| cap[1].to_string()).unwrap_or_default();
479            let etag = etag_regex.captures(inner_content).map(|cap| cap[1].to_string()).unwrap_or_default();
480            let size = size_regex.captures(inner_content).and_then(|cap| cap[1].parse().ok()).unwrap_or(0);
481            let storage_class = storage_class_regex.captures(inner_content).map(|cap| cap[1].to_string()).unwrap_or_default();
482            let content = ObjectMeta {
483                key,
484                last_modified,
485                etag,
486                size,
487                storage_class,
488            };
489            contents_vec.push(content);
490        }
491
492        contents_vec
493    }
494}
495
496
497#[cfg(test)]
498mod tests {
499    use super::*;
500    use chrono::{Duration, Local};
501    use std::time::{SystemTime, UNIX_EPOCH};
502
503    #[test]
504    fn test_parse_xml() {
505        let xml = r#"<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ListBucketResult xmlns="http://obs.myhwclouds.com/doc/2015-06-30/"><Name>obs-products</Name><Prefix>tmp</Prefix><Marker></Marker><MaxKeys>1000</MaxKeys><IsTruncated>false</IsTruncated><Contents><Key>tmp/</Key><LastModified>2024-12-03T12:01:48.020Z</LastModified><ETag>"d41d8cd98f00b204e9800998ecf8427e"</ETag><Size>0</Size><Owner><ID>74df55bf376f41d48959d2aa9deaaf38</ID></Owner><StorageClass>STANDARD</StorageClass></Contents><Contents><Key>tmp/index001.png</Key><LastModified>2025-08-20T07:42:59.813Z</LastModified><ETag>"de317c0b7b6e02b42ef2b9e29bb5906a"</ETag><Size>12082</Size><Owner><ID>74df55bf376f41d48959d2aa9deaaf38</ID></Owner><StorageClass>STANDARD</StorageClass></Contents><Contents><Key>tmp/index002.png</Key><LastModified>2025-08-20T07:52:10.204Z</LastModified><ETag>"de317c0b7b6e02b42ef2b9e29bb5906a"</ETag><Size>12082</Size><Owner><ID>74df55bf376f41d48959d2aa9deaaf38</ID></Owner><StorageClass>STANDARD</StorageClass></Contents></ListBucketResult>"#;
506        let parser = XmlParser::new(xml);
507        let contents = parser.parse();
508        let json_data = serde_json::to_string_pretty(&contents).unwrap();
509        println!("{}", json_data);
510    }
511
512    #[test]
513    fn test_timestamp() {
514        let now = Local::now();
515        let two_hours = Duration::hours(2);
516        let future_time = now + two_hours;
517
518        let system_time: SystemTime = future_time.into();
519        let duration = system_time.duration_since(UNIX_EPOCH).unwrap();
520        let timestamp = duration.as_secs();
521        println!("timestamp = {}", timestamp);
522    }
523
524}
obs_sdk/lib.rs

obs_sdk/
lib.rs
