    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
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549

    use std::collections::BTreeMap;
    use std::fs::File;
    use std::io::prelude::*;
    use std::io::{Cursor, SeekFrom};
    use std::time::Instant;

    use curl::easy::{Easy, List};
    use percent_encoding::{percent_encode, NON_ALPHANUMERIC};
    use serde::{Deserialize, Serialize};
    use url::Url;

    pub type Result<T> = std::result::Result<T, Error>;

    pub struct Registry {
        /// The base URL for issuing API requests.
        host: String,
        /// Optional authorization token.
        /// If None, commands requiring authorization will fail.
        token: Option<String>,
        /// Curl handle for issuing requests.
        handle: Easy,
        /// Whether to include the authorization token with all requests.
        auth_required: bool,
    }

    #[derive(PartialEq, Clone, Copy)]
    pub enum Auth {
        Authorized,
        Unauthorized,
    }

    #[derive(Deserialize)]
    pub struct Crate {
        pub name: String,
        pub description: Option<String>,
        pub max_version: String,
    }

    /// This struct is serialized as JSON and sent as metadata ahead of the crate
    /// tarball when publishing crates to a crate registry like crates.io.
    ///
    /// see <https://doc.rust-lang.org/cargo/reference/registry-web-api.html#publish>
    #[derive(Serialize, Deserialize)]
    pub struct NewCrate {
        pub name: String,
        pub vers: String,
        pub deps: Vec<NewCrateDependency>,
        pub features: BTreeMap<String, Vec<String>>,
        pub authors: Vec<String>,
        pub description: Option<String>,
        pub documentation: Option<String>,
        pub homepage: Option<String>,
        pub readme: Option<String>,
        pub readme_file: Option<String>,
        pub keywords: Vec<String>,
        pub categories: Vec<String>,
        pub license: Option<String>,
        pub license_file: Option<String>,
        pub repository: Option<String>,
        pub badges: BTreeMap<String, BTreeMap<String, String>>,
        pub links: Option<String>,
        pub rust_version: Option<String>,
    }

    #[derive(Serialize, Deserialize)]
    pub struct NewCrateDependency {
        pub optional: bool,
        pub default_features: bool,
        pub name: String,
        pub features: Vec<String>,
        pub version_req: String,
        pub target: Option<String>,
        pub kind: String,
        #[serde(skip_serializing_if = "Option::is_none")]
        pub registry: Option<String>,
        #[serde(skip_serializing_if = "Option::is_none")]
        pub explicit_name_in_toml: Option<String>,
        #[serde(skip_serializing_if = "Option::is_none")]
        pub artifact: Option<Vec<String>>,
        #[serde(skip_serializing_if = "Option::is_none")]
        pub bindep_target: Option<String>,
        #[serde(default, skip_serializing_if = "is_false")]
        pub lib: bool,
    }

    fn is_false(x: &bool) -> bool {
        *x == false
    }

    #[derive(Deserialize)]
    pub struct User {
        pub id: u32,
        pub login: String,
        pub avatar: Option<String>,
        pub email: Option<String>,
        pub name: Option<String>,
    }

    pub struct Warnings {
        pub invalid_categories: Vec<String>,
        pub invalid_badges: Vec<String>,
        pub other: Vec<String>,
    }

    #[derive(Deserialize)]
    struct R {
        ok: bool,
    }
    #[derive(Deserialize)]
    struct OwnerResponse {
        ok: bool,
        msg: String,
    }
    #[derive(Deserialize)]
    struct ApiErrorList {
        errors: Vec<ApiError>,
    }
    #[derive(Deserialize)]
    struct ApiError {
        detail: String,
    }
    #[derive(Serialize)]
    struct OwnersReq<'a> {
        users: &'a [&'a str],
    }
    #[derive(Deserialize)]
    struct Users {
        users: Vec<User>,
    }
    #[derive(Deserialize)]
    struct TotalCrates {
        total: u32,
    }
    #[derive(Deserialize)]
    struct Crates {
        crates: Vec<Crate>,
        meta: TotalCrates,
    }

    /// Error returned when interacting with a registry.
    #[derive(Debug, thiserror::Error)]
    pub enum Error {
        /// Error from libcurl.
        #[error(transparent)]
        Curl(#[from] curl::Error),

        /// Error from seriailzing the request payload and deserializing the
        /// response body (like response body didn't match expected structure).
        #[error(transparent)]
        Json(#[from] serde_json::Error),

        /// Error from IO. Mostly from reading the tarball to upload.
        #[error("failed to seek tarball")]
        Io(#[from] std::io::Error),

        /// Response body was not valid utf8.
        #[error("invalid response body from server")]
        Utf8(#[from] std::string::FromUtf8Error),

        /// Error from API response containing JSON field `errors.details`.
        #[error(
            "the remote server responded with an error{}: {}",
            status(*code),
            errors.join(", "),
        )]
        Api {
            code: u32,
            headers: Vec<String>,
            errors: Vec<String>,
        },

        /// Error from API response which didn't have pre-programmed `errors.details`.
        #[error(
            "failed to get a 200 OK response, got {code}\nheaders:\n\t{}\nbody:\n{body}",
            headers.join("\n\t"),
        )]
        Code {
            code: u32,
            headers: Vec<String>,
            body: String,
        },

        /// Reason why the token was invalid.
        #[error("{0}")]
        InvalidToken(&'static str),

        /// Server was unavailable and timeouted. Happened when uploading a way
        /// too large tarball to crates.io.
        #[error(
            "Request timed out after 30 seconds. If you're trying to \
             upload a crate it may be too large. If the crate is under \
             10MB in size, you can email help@crates.io for assistance.\n\
             Total size was {0}."
        )]
        Timeout(u64),
    }

    impl Registry {
        /// Creates a new `Registry`.
        ///
        /// ## Example
        ///
        /// ```rust
        /// use curl::easy::Easy;
        /// use crates_io::Registry;
        ///
        /// let mut handle = Easy::new();
        /// // If connecting to crates.io, a user-agent is required.
        /// handle.useragent("my_crawler (example.com/info)");
        /// let mut reg = Registry::new_handle(String::from("https://crates.io"), None, handle, true);
        /// ```
        pub fn new_handle(
            host: String,
            token: Option<String>,
            handle: Easy,
            auth_required: bool,
        ) -> Registry {
            Registry {
                host,
                token,
                handle,
                auth_required,
            }
        }

        pub fn set_token(&mut self, token: Option<String>) {
            self.token = token;
        }

        fn token(&self) -> Result<&str> {
            let token = self.token.as_ref().ok_or_else(|| {
                Error::InvalidToken("no upload token found, please run `cargo login`")
            })?;
            check_token(token)?;
            Ok(token)
        }

        pub fn host(&self) -> &str {
            &self.host
        }

        pub fn host_is_crates_io(&self) -> bool {
            is_url_crates_io(&self.host)
        }

        pub fn add_owners(&mut self, krate: &str, owners: &[&str]) -> Result<String> {
            let body = serde_json::to_string(&OwnersReq { users: owners })?;
            let body = self.put(&format!("/crates/{}/owners", krate), body.as_bytes())?;
            assert!(serde_json::from_str::<OwnerResponse>(&body)?.ok);
            Ok(serde_json::from_str::<OwnerResponse>(&body)?.msg)
        }

        pub fn remove_owners(&mut self, krate: &str, owners: &[&str]) -> Result<()> {
            let body = serde_json::to_string(&OwnersReq { users: owners })?;
            let body = self.delete(&format!("/crates/{}/owners", krate), Some(body.as_bytes()))?;
            assert!(serde_json::from_str::<OwnerResponse>(&body)?.ok);
            Ok(())
        }

        pub fn list_owners(&mut self, krate: &str) -> Result<Vec<User>> {
            let body = self.get(&format!("/crates/{}/owners", krate))?;
            Ok(serde_json::from_str::<Users>(&body)?.users)
        }

        pub fn publish(&mut self, krate: &NewCrate, mut tarball: &File) -> Result<Warnings> {
            let json = serde_json::to_string(krate)?;
            // Prepare the body. The format of the upload request is:
            //
            //      <le u32 of json>
            //      <json request> (metadata for the package)
            //      <le u32 of tarball>
            //      <source tarball>

            // NOTE: This can be replaced with `stream_len` if it is ever stabilized.
            //
            // This checks the length using seeking instead of metadata, because
            // on some filesystems, getting the metadata will fail because
            // the file was renamed in ops::package.
            let tarball_len = tarball.seek(SeekFrom::End(0))?;
            tarball.seek(SeekFrom::Start(0))?;
            let header = {
                let mut w = Vec::new();
                w.extend(&(json.len() as u32).to_le_bytes());
                w.extend(json.as_bytes().iter().cloned());
                w.extend(&(tarball_len as u32).to_le_bytes());
                w
            };
            let size = tarball_len as usize + header.len();
            let mut body = Cursor::new(header).chain(tarball);

            let url = format!("{}/api/v1/crates/new", self.host);

            self.handle.put(true)?;
            self.handle.url(&url)?;
            self.handle.in_filesize(size as u64)?;
            let mut headers = List::new();
            headers.append("Accept: application/json")?;
            headers.append(&format!("Authorization: {}", self.token()?))?;
            self.handle.http_headers(headers)?;

            let started = Instant::now();
            let body = self
                .handle(&mut |buf| body.read(buf).unwrap_or(0))
                .map_err(|e| match e {
                    Error::Code { code, .. }
                        if code == 503
                            && started.elapsed().as_secs() >= 29
                            && self.host_is_crates_io() =>
                    {
                        Error::Timeout(tarball_len)
                    }
                    _ => e.into(),
                })?;

            let response = if body.is_empty() {
                "{}".parse()?
            } else {
                body.parse::<serde_json::Value>()?
            };

            let invalid_categories: Vec<String> = response
                .get("warnings")
                .and_then(|j| j.get("invalid_categories"))
                .and_then(|j| j.as_array())
                .map(|x| x.iter().flat_map(|j| j.as_str()).map(Into::into).collect())
                .unwrap_or_else(Vec::new);

            let invalid_badges: Vec<String> = response
                .get("warnings")
                .and_then(|j| j.get("invalid_badges"))
                .and_then(|j| j.as_array())
                .map(|x| x.iter().flat_map(|j| j.as_str()).map(Into::into).collect())
                .unwrap_or_else(Vec::new);

            let other: Vec<String> = response
                .get("warnings")
                .and_then(|j| j.get("other"))
                .and_then(|j| j.as_array())
                .map(|x| x.iter().flat_map(|j| j.as_str()).map(Into::into).collect())
                .unwrap_or_else(Vec::new);

            Ok(Warnings {
                invalid_categories,
                invalid_badges,
                other,
            })
        }

        pub fn search(&mut self, query: &str, limit: u32) -> Result<(Vec<Crate>, u32)> {
            let formatted_query = percent_encode(query.as_bytes(), NON_ALPHANUMERIC);
            let body = self.req(
                &format!("/crates?q={}&per_page={}", formatted_query, limit),
                None,
                Auth::Unauthorized,
            )?;

            let crates = serde_json::from_str::<Crates>(&body)?;
            Ok((crates.crates, crates.meta.total))
        }

        pub fn yank(&mut self, krate: &str, version: &str) -> Result<()> {
            let body = self.delete(&format!("/crates/{}/{}/yank", krate, version), None)?;
            assert!(serde_json::from_str::<R>(&body)?.ok);
            Ok(())
        }

        pub fn unyank(&mut self, krate: &str, version: &str) -> Result<()> {
            let body = self.put(&format!("/crates/{}/{}/unyank", krate, version), &[])?;
            assert!(serde_json::from_str::<R>(&body)?.ok);
            Ok(())
        }

        fn put(&mut self, path: &str, b: &[u8]) -> Result<String> {
            self.handle.put(true)?;
            self.req(path, Some(b), Auth::Authorized)
        }

        fn get(&mut self, path: &str) -> Result<String> {
            self.handle.get(true)?;
            self.req(path, None, Auth::Authorized)
        }

        fn delete(&mut self, path: &str, b: Option<&[u8]>) -> Result<String> {
            self.handle.custom_request("DELETE")?;
            self.req(path, b, Auth::Authorized)
        }

        fn req(&mut self, path: &str, body: Option<&[u8]>, authorized: Auth) -> Result<String> {
            self.handle.url(&format!("{}/api/v1{}", self.host, path))?;
            let mut headers = List::new();
            headers.append("Accept: application/json")?;
            if body.is_some() {
                headers.append("Content-Type: application/json")?;
            }

            if self.auth_required || authorized == Auth::Authorized {
                headers.append(&format!("Authorization: {}", self.token()?))?;
            }
            self.handle.http_headers(headers)?;
            match body {
                Some(mut body) => {
                    self.handle.upload(true)?;
                    self.handle.in_filesize(body.len() as u64)?;
                    self.handle(&mut |buf| body.read(buf).unwrap_or(0))
                        .map_err(|e| e.into())
                }
                None => self.handle(&mut |_| 0).map_err(|e| e.into()),
            }
        }

        fn handle(&mut self, read: &mut dyn FnMut(&mut [u8]) -> usize) -> Result<String> {
            let mut headers = Vec::new();
            let mut body = Vec::new();
            {
                let mut handle = self.handle.transfer();
                handle.read_function(|buf| Ok(read(buf)))?;
                handle.write_function(|data| {
                    body.extend_from_slice(data);
                    Ok(data.len())
                })?;
                handle.header_function(|data| {
                    // Headers contain trailing \r\n, trim them to make it easier
                    // to work with.
                    let s = String::from_utf8_lossy(data).trim().to_string();
                    // Don't let server sneak extra lines anywhere.
                    if s.contains('\n') {
                        return true;
                    }
                    headers.push(s);
                    true
                })?;
                handle.perform()?;
            }

            let body = String::from_utf8(body)?;
            let errors = serde_json::from_str::<ApiErrorList>(&body)
                .ok()
                .map(|s| s.errors.into_iter().map(|s| s.detail).collect::<Vec<_>>());

            match (self.handle.response_code()?, errors) {
                (0, None) => Ok(body),
                (code, None) if is_success(code) => Ok(body),
                (code, Some(errors)) => Err(Error::Api {
                    code,
                    headers,
                    errors,
                }),
                (code, None) => Err(Error::Code {
                    code,
                    headers,
                    body,
                }),
            }
        }
    }

    fn is_success(code: u32) -> bool {
        code >= 200 && code < 300
    }

    fn status(code: u32) -> String {
        if is_success(code) {
            String::new()
        } else {
            let reason = reason(code);
            format!(" (status {code} {reason})")
        }
    }

    fn reason(code: u32) -> &'static str {
        // Taken from https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
        match code {
            100 => "Continue",
            101 => "Switching Protocol",
            103 => "Early Hints",
            200 => "OK",
            201 => "Created",
            202 => "Accepted",
            203 => "Non-Authoritative Information",
            204 => "No Content",
            205 => "Reset Content",
            206 => "Partial Content",
            300 => "Multiple Choice",
            301 => "Moved Permanently",
            302 => "Found",
            303 => "See Other",
            304 => "Not Modified",
            307 => "Temporary Redirect",
            308 => "Permanent Redirect",
            400 => "Bad Request",
            401 => "Unauthorized",
            402 => "Payment Required",
            403 => "Forbidden",
            404 => "Not Found",
            405 => "Method Not Allowed",
            406 => "Not Acceptable",
            407 => "Proxy Authentication Required",
            408 => "Request Timeout",
            409 => "Conflict",
            410 => "Gone",
            411 => "Length Required",
            412 => "Precondition Failed",
            413 => "Payload Too Large",
            414 => "URI Too Long",
            415 => "Unsupported Media Type",
            416 => "Request Range Not Satisfiable",
            417 => "Expectation Failed",
            429 => "Too Many Requests",
            431 => "Request Header Fields Too Large",
            500 => "Internal Server Error",
            501 => "Not Implemented",
            502 => "Bad Gateway",
            503 => "Service Unavailable",
            504 => "Gateway Timeout",
            _ => "<unknown>",
        }
    }

    /// Returns `true` if the host of the given URL is "crates.io".
    pub fn is_url_crates_io(url: &str) -> bool {
        Url::parse(url)
            .map(|u| u.host_str() == Some("crates.io"))
            .unwrap_or(false)
    }

    /// Checks if a token is valid or malformed.
    ///
    /// This check is necessary to prevent sending tokens which create an invalid HTTP request.
    /// It would be easier to check just for alphanumeric tokens, but we can't be sure that all
    /// registries only create tokens in that format so that is as less restricted as possible.
    pub fn check_token(token: &str) -> Result<()> {
        if token.is_empty() {
            return Err(Error::InvalidToken("please provide a non-empty token"));
        }
        if token.bytes().all(|b| {
            // This is essentially the US-ASCII limitation of
            // https://www.rfc-editor.org/rfc/rfc9110#name-field-values. That is,
            // visible ASCII characters (0x21-0x7e), space, and tab. We want to be
            // able to pass this in an HTTP header without encoding.
            b >= 32 && b < 127 || b == b'\t'
        }) {
            Ok(())
        } else {
            Err(Error::InvalidToken(
                "token contains invalid characters.\nOnly printable ISO-8859-1 characters \
                 are allowed as it is sent in a HTTPS header.",
            ))
        }
    }