nv-redfish-bmc-http 0.9.1

HTTP client for nv-redfish
Documentation 
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

// SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
//
// 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.

//! HTTP credentials type.

use std::fmt;

/// Credentials used to access the BMC.
///
/// Security notes:
/// - `Debug`/`Display` redact secrets by design.
/// - Prefer short-lived instances and avoid logging credentials.
#[derive(Clone, Hash, PartialEq, Eq)]
pub enum BmcCredentials {
    /// Use HTTP Basic authentication with username and password.
    UsernamePassword {
        /// Username to access BMC.
        username: String,
        /// Password to access BMC.
        password: Option<String>,
    },
    /// Use Redfish session token authentication.
    Token {
        /// Token value.
        token: String,
    },
}

impl BmcCredentials {
    /// Create username/password credentials.
    #[must_use]
    pub const fn username_password(username: String, password: Option<String>) -> Self {
        Self::UsernamePassword { username, password }
    }

    /// Create token credentials.
    #[must_use]
    pub const fn token(token: String) -> Self {
        Self::Token { token }
    }

    /// Create new username/password credentials.
    #[must_use]
    pub const fn new(username: String, password: String) -> Self {
        Self::username_password(username, Some(password))
    }
}

impl fmt::Debug for BmcCredentials {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::UsernamePassword { username, .. } => f
                .debug_struct("BmcCredentials::UsernamePassword")
                .field("username", username)
                .field("password", &"[REDACTED]")
                .finish(),
            Self::Token { .. } => f
                .debug_struct("BmcCredentials::Token")
                .field("token", &"[REDACTED]")
                .finish(),
        }
    }
}

impl fmt::Display for BmcCredentials {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::UsernamePassword { username, .. } => {
                write!(
                    f,
                    "BmcCredentials::UsernamePassword(username: {username}, password: [REDACTED])"
                )
            }
            Self::Token { .. } => write!(f, "BmcCredentials::Token(token: [REDACTED])"),
        }
    }
}