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;
139use urlencoding::encode;
140
141/// 华为云OBS客户端
142/// 
143pub struct ObsClient {
144    pub endpoint: String,
145    pub ak: String,
146    pub sk: String,
147    pub bucket: String,
148}
149
150impl ObsClient {
151
152    /// 列举指定前缀开头的所有对象元数据，方法内部会构造http请求：
153    /// ```plain
154    /// GET / HTTP/1.1
155    /// Host: bucketname.obs.cn-north-4.myhuaweicloud.com
156    /// Date: date
157    /// Authorization: authorization
158    /// ```
159    /// 
160    pub async fn list(&self, prefix: &str) -> Result<Vec<ObjectMeta>, Box<dyn std::error::Error>> {
161        // 构造完整的url地址
162        let url = format!("https://{}.{}/?prefix={}", self.bucket, self.endpoint, prefix);
163
164        //  获取GMT格式的时间字符串
165        let date = utils::now_str_gmt();
166
167        // 创建HmacSha1对象
168        let hmacsha1 = HmacSha1();
169
170        // 构造签名用的原始字符串
171        let string_to_sign = hmacsha1.header_string_to_sign("GET", "", "", &date, "",  &format!("/{}/", self.bucket));
172
173        // 根据原始字符串+ak，获取header签名
174        let signature = hmacsha1.sign_to_base64string(&string_to_sign, &self.sk);
175
176        // 构造请求头Authorization的值
177        let authorization = format!("OBS {}:{}", self.ak, signature);
178        // 构造http请求
179        let client = reqwest::Client::new();
180        let res = client.get(url)
181            .header("Date", &date)
182            .header("Authorization", &authorization)
183            .send()
184            .await?;
185
186        // 如果请求成功，则返回字节内容
187        if res.status().is_success() {
188            let xml_content_string = res.text().await?;
189            let results = XmlParser::new(&xml_content_string).parse();
190            return Ok(results);
191        }
192
193        Err(Box::new(Error::new(ErrorKind::Other, format!("请求失败，状态码={}", res.status()))))
194    }
195
196    /// 上传对象
197    /// 
198    /// 方法内部构建请求
199    /// ```plain
200    /// PUT /object01 HTTP/1.1
201    /// User-Agent: curl/7.29.0
202    /// Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
203    /// Accept: */*
204    /// Date: WED, 01 Jul 2015 04:11:15 GMT
205    /// Authorization: OBS H4IPJX0TQTHTHEBQQCEC:gYqplLq30dEX7GMi2qFWyjdFsyw=
206    /// Content-Length: 10240
207    /// Expect: 100-continue
208    /// 
209    /// [1024 Byte data content]
210    /// ```
211    /// 
212    pub async fn upload_object(&self, obj_key: &str, data: Vec<u8>) -> Result<(), Box<dyn std::error::Error>> {
213        let obj_key = &Self::urlencode(obj_key);
214        // 构造完整的url地址
215        let url = format!("https://{}.{}/{}", self.bucket, self.endpoint, obj_key);
216
217        let md5_string = utils::base64_md5_str(&data);
218
219        //  获取GMT格式的时间字符串
220        let date = utils::now_str_gmt();
221
222        // 创建HmacSha1对象
223        let hmacsha1 = HmacSha1();
224
225        let file_type = &utils::get_mime_type_from_extension(obj_key)
226            .unwrap_or(String::from("application/octet-stream"));
227
228        // 构造签名用的原始字符串
229        let string_to_sign = hmacsha1.header_string_to_sign("PUT", &md5_string, file_type, &date, "",  &format!("/{}/{}", self.bucket, obj_key));
230
231        // 根据原始字符串+ak，获取header签名
232        let signature = hmacsha1.sign_to_base64string(&string_to_sign, &self.sk);
233
234        // 构造请求头Authorization的值
235        let authorization = format!("OBS {}:{}", self.ak, signature);
236
237        // 构造http请求
238        let client = reqwest::Client::new();
239        let res = client.put(url)
240            .header("Content-MD5", &md5_string)
241            .header("Date", &date)
242            .header("Content-Type", file_type)
243            .header("Content-Length", data.len())
244            .header("Authorization", authorization)
245            .body(data)
246            .send()
247            .await;
248
249        let res = match res {
250            Ok(response) => response,
251            Err(e) => {
252                return Err(Box::new(std::io::Error::new(std::io::ErrorKind::Other, e)));
253            },
254        };
255        let _status: StatusCode = res.status();
256
257        Ok(())
258
259    }
260
261    /// 上传文件
262    pub async fn upload_file(&self, obj_key: &str, file_path: &str) -> Result<(), Box<dyn std::error::Error>> {
263        let data = fs::read(file_path)?;
264        self.upload_object(obj_key, data).await
265    }
266
267    /// 下载对象，方法内部会构造http请求：
268    /// ```plain
269    /// GET /{obj_key} HTTP/1.1
270    /// Host: {bucket}.obs.cn-north-4.myhuaweicloud.com
271    /// Date: {date}
272    /// ```
273    /// 
274    pub async fn download_object(&self, obj_key: &str) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
275        let obj_key = &Self::urlencode(obj_key);
276        // 构造完整的url地址
277        let url = format!("https://{}.{}/{}", self.bucket, self.endpoint, obj_key);
278
279        //  获取GMT格式的时间字符串
280        let date = utils::now_str_gmt();
281
282        // 创建HmacSha1对象
283        let hmacsha1 = HmacSha1();
284
285        // 构造签名用的原始字符串
286        let string_to_sign = hmacsha1.header_string_to_sign("GET", "", "", &date, "",  &format!("/{}/{}", self.bucket, obj_key));
287
288        // 根据原始字符串+ak，获取header签名
289        let signature = hmacsha1.sign_to_base64string(&string_to_sign, &self.sk);
290
291        // 构造请求头Authorization的值
292        let authorization = format!("OBS {}:{}", self.ak, signature);
293
294        // 构造http请求
295        let client = reqwest::Client::new();
296        let res = client.get(url)
297            .header("Authorization", &authorization)
298            .header("Date", &date)
299            .send()
300            .await?;
301
302        // 如果请求成功，则返回字节内容
303        if res.status().is_success() {
304            return Ok(res.bytes().await?.to_vec());
305        }
306        
307        Err(Box::new(Error::new(ErrorKind::Other, format!("请求失败，状态码={}", res.status()))))
308    }
309
310    /// 删除obs上的对象
311    pub async fn delete_object(&self, obj_key: &str) -> Result<(), Box<dyn std::error::Error>> {
312        let obj_key = &Self::urlencode(obj_key);
313        // 构造完整的url地址
314        let url = format!("https://{}.{}/{}", self.bucket, self.endpoint, obj_key);
315
316        let md5_string = "";
317
318        //  获取GMT格式的时间字符串
319        let date = utils::now_str_gmt();
320
321        // 创建HmacSha1对象
322        let hmacsha1 = HmacSha1();
323
324        // 构造签名用的原始字符串
325        let string_to_sign = hmacsha1.header_string_to_sign("DELETE", &md5_string, "", &date, "",  &format!("/{}/{}", self.bucket, obj_key));
326
327        // 根据原始字符串+ak，获取header签名
328        let signature = hmacsha1.sign_to_base64string(&string_to_sign, &self.sk);
329
330        // 构造请求头Authorization的值
331        let authorization = format!("OBS {}:{}", self.ak, signature);
332
333        // 构造http请求
334        let client = reqwest::Client::new();
335        let res = client.delete(url)
336            .header("Date", &date)
337            .header("Authorization", authorization)
338            .send()
339            .await;
340
341        let res = match res {
342            Ok(response) => response,
343            Err(e) => {
344                return Err(Box::new(std::io::Error::new(std::io::ErrorKind::Other, e)));
345            },
346        };
347        let status = res.status();
348        println!("status = {}, {}", status, res.text_with_charset("utf-8").await?);
349
350        Ok(())
351    }
352
353    /// 下载文件，并指定本地保存用的文件路径
354    /// 
355    /// # 参数
356    /// 
357    /// `overwrite` - 是否覆盖，true，当文件存在时，覆盖文件，false，当文件存在时，不覆盖文件
358    /// 
359    pub async fn download_file(&self, obj_key: &str, file_path: &str, overwrite: bool) -> Result<(), Box<dyn std::error::Error>> {
360        let file_path = Path::new(file_path);
361
362        // 判断文件是否存在，如果存在，不做任何操作
363        if file_path.exists() && !overwrite {
364            return Err(Box::new(Error::new(ErrorKind::AlreadyExists, "文件已存在，请删除文件或设置覆盖参数")));
365        }
366
367        // 根据父目录是否存在，选择性创建父目录
368        let parent = file_path.parent().unwrap();
369        if !parent.exists() {
370            fs::create_dir_all(&parent)?;
371        }
372
373        // 下载文件，得到原始文件字节内容
374        let data = self.download_object(obj_key).await?;
375        
376        // 保存文件
377        fs::write(file_path, data)?;
378        Ok(())
379    }
380
381    pub fn url_sign(&self, url_str: &str) -> Result<String, Box<dyn std::error::Error>> {
382        let obs_object_url = Url::parse(url_str)?;
383        let resource_part = obs_object_url.path();
384        let host = obs_object_url.host().unwrap();
385        let domain = match host {
386            url::Host::Domain(domain) => domain.to_string(),
387            _ => format!("{}.{}", self.bucket, self.endpoint)
388        };
389        let parts: Vec<&str> = domain.split(".").collect();
390        let bucket_name = parts[0];
391
392        let timestamp = utils::timestamp(Local::now(), 3600*2);
393
394        //  获取GMT格式的时间字符串
395        let expires = format!("{}", timestamp);
396
397        // 创建HmacSha1对象
398        let hmacsha1 = HmacSha1();
399
400        // 构造签名用的原始字符串
401        let string_to_sign = hmacsha1.url_string_to_sign("GET", "", "", &expires, "",  &format!("/{}{}", bucket_name, resource_part));
402
403        // 根据原始字符串+ak，获取header签名
404        let signature = hmacsha1.sign_to_base64string(&string_to_sign, &self.sk);
405        let signature = form_urlencoded::byte_serialize(signature.as_bytes()).collect::<String>();
406
407        // 构造url
408        let sign_url = format!("{}?AccessKeyId={}&Expires={}&Signature={}", url_str, self.ak, expires, signature);
409        Ok(sign_url)
410    }
411
412    fn urlencode(s: &str) -> String {
413        let tokens: Vec<String> = s.split("/").map(|token| {
414            encode(token).to_string()
415        }).collect();
416        tokens.join("/")
417    }
418
419}
420
421
422/// obs对象的元数据信息
423/// 
424/// 这个结构体用于表示 OBS 对象的元数据，包含对象的各种属性，如名称、修改时间、内容标识、大小以及存储类型。
425#[derive(Serialize, Deserialize, Debug)]
426pub struct ObjectMeta {
427
428    /// 对象名
429    /// 
430    /// 唯一标识 OBS 存储中的对象
431    pub key: String,
432
433    /// 对象最近一次被修改的时间（UTC时间）
434    /// 
435    /// 该时间戳表示对象在 OBS 存储中最后一次被修改的时刻，采用 UTC 时间格式。
436    pub last_modified: String,
437
438    /// 对象的base64编码的128位MD5摘要
439    /// 
440    /// 这个 ETag 值是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。
441    pub etag: String,
442
443    /// 对象的字节数
444    /// 
445    /// 表示对象在存储中占用的字节大小
446    pub size: u64,
447
448    /// 对象的存储类型：STANDARD，WARM，COLD，DEEP_ARCHIVE
449    /// 
450    /// 不同的存储类型对应不同的存储成本和访问性能，用户可以根据对象的访问频率等因素选择合适的存储类型
451    pub storage_class: String,
452}
453
454/// XML解析器
455/// 
456/// 用于解析XML格式的响应数据，目前这里面针对obs的接口“列举桶内对象”的响应结果进行解析，没有进行通用的xml解析，其不能作为通用工具使用
457struct XmlParser { 
458    xml: String,
459}
460
461
462impl XmlParser {
463    fn new(xml: &str) -> Self {
464        XmlParser { xml: xml.to_string() }
465    }
466
467    /// 解析obs接口“列举桶内对象”的响应结果
468    /// 
469    /// 该内部采用正则表达式进行解析，因此依赖外部的regex库
470    fn parse(&self) -> Vec<ObjectMeta> {
471        let xml = &self.xml;
472
473        // 定义解析需要使用的正则表达式
474        let contents_re = Regex::new(r#"<Contents>(.*?)</Contents>"#).unwrap();
475        let key_regex = Regex::new(r#"<Key>(.*?)</Key>"#).unwrap();
476        let last_modified_regex = Regex::new(r#"<LastModified>(.*?)</LastModified>"#).unwrap();
477        let etag_regex = Regex::new(r#"<ETag>(.*?)</ETag>"#).unwrap();
478        let size_regex = Regex::new(r#"<Size>(.*?)</Size>"#).unwrap();
479        let storage_class_regex = Regex::new(r#"<StorageClass>(.*?)</StorageClass>"#).unwrap();
480
481
482        // 解析Contents标签内的数据
483        let mut contents_vec = Vec::new();
484        for captures in contents_re.captures_iter(xml) {
485            let inner_content = &captures[1];
486
487            let key = key_regex.captures(inner_content).map(|cap| cap[1].to_string()).unwrap_or_default();
488            let last_modified = last_modified_regex.captures(inner_content).map(|cap| cap[1].to_string()).unwrap_or_default();
489            let etag = etag_regex.captures(inner_content).map(|cap| cap[1].to_string()).unwrap_or_default();
490            let size = size_regex.captures(inner_content).and_then(|cap| cap[1].parse().ok()).unwrap_or(0);
491            let storage_class = storage_class_regex.captures(inner_content).map(|cap| cap[1].to_string()).unwrap_or_default();
492            let content = ObjectMeta {
493                key,
494                last_modified,
495                etag,
496                size,
497                storage_class,
498            };
499            contents_vec.push(content);
500        }
501
502        contents_vec
503    }
504}
505
506
507#[cfg(test)]
508mod tests {
509    use super::*;
510    use chrono::{Duration, Local};
511    use std::time::{SystemTime, UNIX_EPOCH};
512
513    #[test]
514    fn test_parse_xml() {
515        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>"#;
516        let parser = XmlParser::new(xml);
517        let contents = parser.parse();
518        let json_data = serde_json::to_string_pretty(&contents).unwrap();
519        println!("{}", json_data);
520    }
521
522    #[test]
523    fn test_timestamp() {
524        let now = Local::now();
525        let two_hours = Duration::hours(2);
526        let future_time = now + two_hours;
527
528        let system_time: SystemTime = future_time.into();
529        let duration = system_time.duration_since(UNIX_EPOCH).unwrap();
530        let timestamp = duration.as_secs();
531        println!("timestamp = {}", timestamp);
532    }
533
534}
obs_sdk/lib.rs

obs_sdk/
lib.rs
