ipmi 0.1.2

IPMI v2.0 RMCP+ client library (async-first + optional blocking) with session authentication, integrity and confidentiality.
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
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

# ipmi

<a href="https://crates.io/crates/ipmi">
  <img src="https://img.shields.io/crates/v/ipmi.svg" alt="crates.io version">
</a>

A production-oriented **IPMI v2.0 RMCP+** client library (async-first + optional blocking).

This crate focuses on:

- **IPMI v2.0 RMCP+ session establishment** (Open Session + RAKP 1-4)
- **Integrity**: HMAC-SHA1-96
- **Confidentiality**: AES-CBC-128
- **Async API** (tokio, default)
- **Blocking API** (feature `blocking`)

> Note: IPMI is a large specification. This crate implements a secure and commonly supported baseline (mandatory-to-implement algorithms) and provides a solid foundation for adding more commands and cipher suites.

## Install

Async API (default):

```toml
[dependencies]
ipmi = "0.1"
```

Blocking API without pulling tokio:

```toml
[dependencies]
ipmi = { version = "0.1", default-features = false, features = ["blocking"] }
```

Observability (optional):

```toml
[dependencies]
ipmi = { version = "0.1", features = ["tracing", "metrics"] }
```

## Quick start (async)

```rust
use ipmi::{Client, PrivilegeLevel};

// You need a tokio runtime in your application to use the async client.
#[tokio::main]
async fn main() -> ipmi::Result<()> {
    let target = "192.0.2.10:623".parse()?;

    let client = Client::builder(target)
        .username("ADMIN")
        .password("secret")
        .privilege_level(PrivilegeLevel::Administrator)
        .timeout(std::time::Duration::from_secs(2))
        .retries(3)
        .build()
        .await?;

    let device_id = client.get_device_id().await?;
    println!("BMC: {:?}", device_id);

    // Optional: explicitly close the session when you're done.
    let _ = client.close_session().await;

    Ok(())
}
```

## Quick start (blocking)

```rust
use ipmi::{BlockingClient, PrivilegeLevel};

fn main() -> ipmi::Result<()> {
    let target = "192.0.2.10:623".parse()?;

    let client = BlockingClient::builder(target)
        .username("ADMIN")
        .password("secret")
        .privilege_level(PrivilegeLevel::Administrator)
        .timeout(std::time::Duration::from_secs(2))
        .retries(3)
        .build()?;

    let device_id = client.get_device_id()?;
    println!("BMC: {:?}", device_id);

    // Optional: explicitly close the session when you're done.
    let _ = client.close_session();

    Ok(())
}
```

## Typed commands

The crate exposes a typed command interface in `ipmi::commands`. You can execute built-in commands
directly, or implement `commands::Command` for custom commands:

```rust
use ipmi::commands::GetDeviceId;

let device_id = client.execute(GetDeviceId).await?;
let device_id = blocking_client.execute(GetDeviceId)?;
```

## Security notes

- Password / KG are stored in memory only for the duration of session establishment and are zeroized on drop.
- Session keys are zeroized when the client is dropped.
- The client verifies integrity checks (HMAC) before decrypting payloads.
- The library avoids `unwrap()`/`expect()` in production code.

## Feature support

- Transport: UDP/623 (LAN)
- Session: RMCP+ / RAKP (IPMI v2.0)
- Commands:
  - `Get Device ID` (netfn `0x06`, cmd `0x01`)
  - `Get Self Test Results` (netfn `0x06`, cmd `0x04`)
  - `Get System GUID` (netfn `0x06`, cmd `0x37`)
  - `Get Chassis Status` (netfn `0x00`, cmd `0x01`)
  - `Chassis Control` (netfn `0x00`, cmd `0x02`)
  - `Get Channel Authentication Capabilities` (netfn `0x06`, cmd `0x38`)
  - `Close Session` (netfn `0x06`, cmd `0x3C`)
  - `send_raw()` for arbitrary commands