    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289

    // MinIO Rust Library for Amazon S3 Compatible Cloud Storage
    // Copyright 2022 MinIO, Inc.
    //
    // Licensed under the Apache License, Version 2.0 (the "License");
    // you may not use this file except in compliance with the License.
    // You may obtain a copy of the License at
    //
    //     http://www.apache.org/licenses/LICENSE-2.0
    //
    // Unless required by applicable law or agreed to in writing, software
    // distributed under the License is distributed on an "AS IS" BASIS,
    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    // See the License for the specific language governing permissions and
    // limitations under the License.

    use crate::s3::error::Error;
    pub use base64::encode as b64encode;
    use byteorder::{BigEndian, ReadBytesExt};
    use chrono::{DateTime, NaiveDateTime, ParseError, Utc};
    use chrono_locale::LocaleDate;
    use crc::{Crc, CRC_32_ISO_HDLC};
    use lazy_static::lazy_static;
    use md5::compute as md5compute;
    use multimap::MultiMap;
    use regex::Regex;
    use sha2::{Digest, Sha256};
    use std::collections::BTreeMap;
    pub use urlencoding::decode as urldecode;
    pub use urlencoding::encode as urlencode;
    use xmltree::Element;

    pub type UtcTime = DateTime<Utc>;

    pub type Multimap = MultiMap<String, String>;

    pub fn merge(m1: &mut Multimap, m2: &Multimap) {
        for (key, values) in m2.iter_all() {
            for value in values {
                m1.insert(key.to_string(), value.to_string());
            }
        }
    }

    pub fn crc32(data: &[u8]) -> u32 {
        Crc::<u32>::new(&CRC_32_ISO_HDLC).checksum(data)
    }

    pub fn uint32(mut data: &[u8]) -> Result<u32, std::io::Error> {
        data.read_u32::<BigEndian>()
    }

    pub fn sha256_hash(data: &[u8]) -> String {
        let mut hasher = Sha256::new();
        hasher.update(data);
        return format!("{:x}", hasher.finalize());
    }

    pub fn md5sum_hash(data: &[u8]) -> String {
        b64encode(md5compute(data).as_slice())
    }

    pub fn utc_now() -> UtcTime {
        chrono::offset::Utc::now()
    }

    pub fn to_signer_date(time: UtcTime) -> String {
        time.format("%Y%m%d").to_string()
    }

    pub fn to_amz_date(time: UtcTime) -> String {
        time.format("%Y%m%dT%H%M%SZ").to_string()
    }

    pub fn to_http_header_value(time: UtcTime) -> String {
        time.formatl("%a, %d %b %Y %H:%M:%S GMT", "C").to_string()
    }

    pub fn to_iso8601utc(time: UtcTime) -> String {
        time.format("%Y-%m-%dT%H:%M:%S.%3fZ").to_string()
    }

    pub fn from_iso8601utc(s: &str) -> Result<UtcTime, ParseError> {
        Ok(DateTime::<Utc>::from_utc(
            match NaiveDateTime::parse_from_str(s, "%Y-%m-%dT%H:%M:%S.%3fZ") {
                Ok(d) => d,
                _ => NaiveDateTime::parse_from_str(s, "%Y-%m-%dT%H:%M:%SZ")?,
            },
            Utc,
        ))
    }

    pub fn from_http_header_value(s: &str) -> Result<UtcTime, ParseError> {
        Ok(DateTime::<Utc>::from_utc(
            NaiveDateTime::parse_from_str(s, "%a, %d %b %Y %H:%M:%S GMT")?,
            Utc,
        ))
    }

    pub fn to_http_headers(map: &Multimap) -> Vec<String> {
        let mut headers: Vec<String> = Vec::new();
        for (key, values) in map.iter_all() {
            for value in values {
                let mut s = String::new();
                s.push_str(key);
                s.push_str(": ");
                s.push_str(value);
                headers.push(s);
            }
        }
        return headers;
    }

    pub fn to_query_string(map: &Multimap) -> String {
        let mut query = String::new();
        for (key, values) in map.iter_all() {
            for value in values {
                if !query.is_empty() {
                    query.push_str("&");
                }
                query.push_str(&urlencode(key));
                query.push_str("=");
                query.push_str(&urlencode(value));
            }
        }
        return query;
    }

    pub fn get_canonical_query_string(map: &Multimap) -> String {
        let mut keys: Vec<String> = Vec::new();
        for (key, _) in map.iter() {
            keys.push(key.to_string());
        }
        keys.sort();

        let mut query = String::new();
        for key in keys {
            match map.get_vec(key.as_str()) {
                Some(values) => {
                    for value in values {
                        if !query.is_empty() {
                            query.push_str("&");
                        }
                        query.push_str(&urlencode(key.as_str()));
                        query.push_str("=");
                        query.push_str(&urlencode(value));
                    }
                }
                None => todo!(), // This never happens.
            };
        }

        return query;
    }

    pub fn get_canonical_headers(map: &Multimap) -> (String, String) {
        lazy_static! {
            static ref MULTI_SPACE_REGEX: Regex = Regex::new("( +)").unwrap();
        }
        let mut btmap: BTreeMap<String, String> = BTreeMap::new();

        for (k, values) in map.iter_all() {
            let key = k.to_lowercase();
            if "authorization" == key || "user-agent" == key {
                continue;
            }

            let mut vs = values.clone();
            vs.sort();

            let mut value = String::new();
            for v in vs {
                if !value.is_empty() {
                    value.push_str(",");
                }
                let s: String = MULTI_SPACE_REGEX.replace_all(&v, " ").to_string();
                value.push_str(&s);
            }
            btmap.insert(key.clone(), value.clone());
        }

        let mut signed_headers = String::new();
        let mut canonical_headers = String::new();
        let mut add_delim = false;
        for (key, value) in &btmap {
            if add_delim {
                signed_headers.push_str(";");
                canonical_headers.push_str("\n");
            }

            signed_headers.push_str(key);

            canonical_headers.push_str(key);
            canonical_headers.push_str(":");
            canonical_headers.push_str(value);

            add_delim = true;
        }

        return (signed_headers, canonical_headers);
    }

    pub fn check_bucket_name(bucket_name: &str, strict: bool) -> Result<(), Error> {
        if bucket_name.trim().is_empty() {
            return Err(Error::InvalidBucketName(String::from(
                "bucket name cannot be empty",
            )));
        }

        if bucket_name.len() < 3 {
            return Err(Error::InvalidBucketName(String::from(
                "bucket name cannot be less than 3 characters",
            )));
        }

        if bucket_name.len() > 63 {
            return Err(Error::InvalidBucketName(String::from(
                "Bucket name cannot be greater than 63 characters",
            )));
        }

        lazy_static! {
            static ref VALID_IP_ADDR_REGEX: Regex = Regex::new("^(\\d+\\.){3}\\d+$").unwrap();
            static ref VALID_BUCKET_NAME_REGEX: Regex =
                Regex::new("^[A-Za-z0-9][A-Za-z0-9\\.\\-_:]{1,61}[A-Za-z0-9]$").unwrap();
            static ref VALID_BUCKET_NAME_STRICT_REGEX: Regex =
                Regex::new("^[a-z0-9][a-z0-9\\.\\-]{1,61}[a-z0-9]$").unwrap();
        }

        if VALID_IP_ADDR_REGEX.is_match(bucket_name) {
            return Err(Error::InvalidBucketName(String::from(
                "bucket name cannot be an IP address",
            )));
        }

        if bucket_name.contains("..") || bucket_name.contains(".-") || bucket_name.contains("-.") {
            return Err(Error::InvalidBucketName(String::from(
                "bucket name contains invalid successive characters '..', '.-' or '-.'",
            )));
        }

        if strict {
            if !VALID_BUCKET_NAME_STRICT_REGEX.is_match(bucket_name) {
                return Err(Error::InvalidBucketName(String::from(
                    "bucket name does not follow S3 standards strictly",
                )));
            }
        } else if !VALID_BUCKET_NAME_REGEX.is_match(bucket_name) {
            return Err(Error::InvalidBucketName(String::from(
                "bucket name does not follow S3 standards",
            )));
        }

        return Ok(());
    }

    pub fn get_text(element: &Element, tag: &str) -> Result<String, Error> {
        Ok(element
            .get_child(tag)
            .ok_or(Error::XmlError(format!("<{}> tag not found", tag)))?
            .get_text()
            .ok_or(Error::XmlError(format!("text of <{}> tag not found", tag)))?
            .to_string())
    }

    pub fn get_option_text(element: &Element, tag: &str) -> Result<Option<String>, Error> {
        Ok(match element.get_child(tag) {
            Some(v) => Some(
                v.get_text()
                    .ok_or(Error::XmlError(format!("text of <{}> tag not found", tag)))?
                    .to_string(),
            ),
            None => None,
        })
    }

    pub fn get_default_text(element: &Element, tag: &str) -> String {
        element.get_child(tag).map_or(String::new(), |v| {
            v.get_text().unwrap_or_default().to_string()
        })
    }

    pub fn copy_slice(dst: &mut [u8], src: &[u8]) -> usize {
        let mut c = 0;
        for (d, s) in dst.iter_mut().zip(src.iter()) {
            *d = *s;
            c += 1;
        }
        c
    }