azure-pim-cli 0.16.0

Unofficial CLI to list and enable Azure Privileged Identity Management (PIM) roles
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
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
use crate::models::roles::RoleAssignment;
use anyhow::{anyhow, Result};
use ratatui::{
    crossterm::{
        event::{
            self, Event,
            KeyCode::{BackTab, Backspace, Char, Down, Enter, Esc, Tab, Up},
            KeyEventKind,
        },
        execute,
        terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
    },
    prelude::*,
    widgets::{
        Block, BorderType, Cell, HighlightSpacing, Paragraph, Row, Scrollbar, ScrollbarOrientation,
        ScrollbarState, Table, TableState,
    },
};
use std::{collections::BTreeSet, io::stdout};

const ENABLED: &str = "";
const DISABLED: &str = "";
const TITLE_TEXT: &str = "Activate Azure PIM roles";
const JUSTIFICATION_TEXT: &str = "Type to enter justification";
const SCOPE_TEXT: &str = "↑ or ↓ to move | Space to toggle";
const DURATION_TEXT: &str = "↑ or ↓ to update duration";
const ALL_HELP: &str = "Tab or Shift-Tab to change sections | Enter to activate | Esc to quit";
const MIN_ITEM_HEIGHT: u16 = 2;
// Width occupied by table chrome inside the bordered block:
// 2 for borders + 1 leading pad + 4 for the highlight spacing column ("  > ").
const SCOPES_CHROME: u16 = 7;
// Minimum width we will allocate to either column before falling back.
const MIN_COL_WIDTH: u16 = 8;

pub struct Selected {
    pub assignments: BTreeSet<RoleAssignment>,
    pub justification: String,
    pub duration: u64,
}

struct Entry {
    value: RoleAssignment,
    enabled: bool,
}

#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
enum InputState {
    Duration,
    Justification,
    Scopes,
}

struct App {
    duration: Option<u64>,
    input_state: InputState,
    table_state: TableState,
    justification: Option<String>,
    items: Vec<Entry>,
    longest_item_lens: (u16, u16),
    scroll_state: ScrollbarState,
    warnings: Vec<String>,
}

impl App {
    fn new(
        assignments: BTreeSet<RoleAssignment>,
        justification: Option<String>,
        duration: Option<u64>,
    ) -> Result<Self> {
        Ok(Self {
            duration,
            input_state: if justification.is_none() {
                InputState::Scopes
            } else {
                InputState::Justification
            },
            table_state: TableState::default().with_selected(0),
            justification,
            longest_item_lens: column_widths(&assignments)?,
            scroll_state: ScrollbarState::new(assignments.len().saturating_sub(1)),
            items: assignments
                .into_iter()
                .map(|value| Entry {
                    value,
                    enabled: false,
                })
                .collect(),
            warnings: Vec::new(),
        })
    }

    fn toggle_current(&mut self) {
        if let Some(i) = self.table_state.selected() {
            if let Some(item) = self.items.get_mut(i) {
                item.enabled = !item.enabled;
            }
        }
    }

    pub fn next(&mut self) {
        let i = match self.table_state.selected() {
            Some(i) => {
                if i >= self.items.len() - 1 {
                    0
                } else {
                    i + 1
                }
            }
            None => 0,
        };
        self.table_state.select(Some(i));
        self.scroll_state = self.scroll_state.position(i);
    }

    pub fn previous(&mut self) {
        let i = match self.table_state.selected() {
            Some(i) => {
                if i == 0 {
                    self.items.len() - 1
                } else {
                    i - 1
                }
            }
            None => 0,
        };
        self.table_state.select(Some(i));
        self.scroll_state = self.scroll_state.position(i);
    }

    fn check(&mut self) {
        self.warnings.clear();
        if self.justification.as_ref().is_some_and(String::is_empty) {
            self.warnings.push("Justification is required".to_string());
        }
        if self.items.iter().all(|x| !x.enabled) {
            self.warnings
                .push("At least one role must be selected".to_string());
        }
    }

    #[allow(clippy::indexing_slicing)]
    fn draw(&mut self, f: &mut Frame) {
        let mut sections = vec![
            // title
            Constraint::Length(1),
        ];

        // justification
        if self.justification.is_some() {
            sections.push(Constraint::Length(3));
        }

        // roles
        sections.push(Constraint::Min(5));

        // duration
        if self.duration.is_some() {
            sections.push(Constraint::Length(3));
        }

        // footer
        sections.push(Constraint::Length(4));

        if !self.warnings.is_empty() {
            sections.push(Constraint::Length(
                2 + u16::try_from(self.warnings.len()).unwrap_or(0),
            ));
        }

        let rects = Layout::vertical(sections).split(f.area());
        let mut rects = rects.iter();

        // from here forward, if the next() call fails, we return early as the
        // rect is missing
        let Some(title) = rects.next() else {
            return;
        };
        Self::render_title(f, *title);

        if self.justification.is_some() {
            let Some(justification) = rects.next() else {
                return;
            };
            self.render_justification(f, *justification);
        }

        let Some(scopes) = rects.next() else {
            return;
        };
        self.render_scopes(f, *scopes);

        if self.duration.is_some() {
            let Some(duration) = rects.next() else {
                return;
            };
            self.render_duration(f, *duration);
        }

        let Some(footer) = rects.next() else {
            return;
        };
        self.render_footer(f, *footer);

        if !self.warnings.is_empty() {
            let Some(warnings) = rects.next() else {
                return;
            };
            self.render_warnings(f, *warnings);
        }
    }

    fn render_warnings(&self, frame: &mut Frame, area: Rect) {
        frame.render_widget(
            Paragraph::new(self.warnings.join("\n"))
                .style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
                .alignment(Alignment::Center)
                .block(Block::bordered().title("Warnings!")),
            area,
        );
    }

    fn render_title(frame: &mut Frame, area: Rect) {
        frame.render_widget(
            Paragraph::new(TITLE_TEXT)
                .style(Style::default().add_modifier(Modifier::BOLD))
                .alignment(Alignment::Center),
            area,
        );
    }

    fn render_duration(&mut self, frame: &mut Frame, area: Rect) {
        // Style::default().add_modifier(Modifier::REVERSED)
        frame.render_widget(
            Paragraph::new(format!("{} minutes", self.duration.unwrap_or_default()))
                .style(if self.input_state == InputState::Duration {
                    Style::default().add_modifier(Modifier::REVERSED)
                } else {
                    Style::default()
                })
                .block(Block::bordered().title("Duration")),
            area,
        );
    }

    fn render_justification(&mut self, frame: &mut Frame, area: Rect) {
        let justification = self.justification.clone().unwrap_or_default();
        frame.render_widget(
            Paragraph::new(justification.clone()).block(Block::bordered().title("Justification")),
            area,
        );
        if self.input_state == InputState::Justification {
            #[allow(clippy::cast_possible_truncation)]
            frame.set_cursor_position((area.x + justification.len() as u16 + 1, area.y + 1));
        }
    }

    fn render_scopes(&mut self, frame: &mut Frame, area: Rect) {
        // Carve up the area between the role and scope columns based on the
        // current terminal width, so long scope paths don't get silently
        // truncated on a normal-width terminal.
        let inner_w = area.width.saturating_sub(SCOPES_CHROME);
        let role_desired = self.longest_item_lens.0.saturating_add(4);
        let scope_desired = self.longest_item_lens.1.saturating_add(1);

        let (role_w, scope_w) = if role_desired.saturating_add(scope_desired) <= inner_w {
            (
                role_desired,
                inner_w.saturating_sub(role_desired).max(MIN_COL_WIDTH),
            )
        } else {
            // Cap the role column at ~40% so the scope path always has room.
            let cap = (inner_w * 2 / 5).max(MIN_COL_WIDTH);
            let role = role_desired.min(cap).max(MIN_COL_WIDTH);
            let scope = inner_w.saturating_sub(role).max(MIN_COL_WIDTH);
            (role, scope)
        };

        let rows = self.items.iter().map(|data| {
            let role_text = format!(
                "{} {}",
                if data.enabled { ENABLED } else { DISABLED },
                data.value.role
            );
            let scope_text = if let Some(scope_name) = data.value.scope_name.as_deref() {
                format!("{scope_name}\n{}", data.value.scope)
            } else {
                data.value.scope.to_string()
            };

            let role_lines = wrap_text(&role_text, role_w);
            let scope_lines = wrap_text(&scope_text, scope_w);
            let height = u16::try_from(role_lines.len().max(scope_lines.len()))
                .unwrap_or(MIN_ITEM_HEIGHT)
                .max(MIN_ITEM_HEIGHT);

            Row::new(vec![
                Cell::from(role_lines.join("\n")),
                Cell::from(scope_lines.join("\n")),
            ])
            .height(height)
        });

        frame.render_stateful_widget(
            Table::new(rows, [Constraint::Length(role_w), Constraint::Min(scope_w)])
                .header(
                    ["Role", "Scope"]
                        .into_iter()
                        .collect::<Row>()
                        .style(Style::default().add_modifier(Modifier::BOLD | Modifier::UNDERLINED))
                        .height(1),
                )
                .row_highlight_style(if self.input_state == InputState::Scopes {
                    Style::default().add_modifier(Modifier::REVERSED)
                } else {
                    Style::default()
                })
                .highlight_spacing(HighlightSpacing::Always)
                .block(Block::bordered().title("Scopes")),
            area,
            &mut self.table_state,
        );

        // Always show a scrollbar so users know whether more rows exist
        // off-screen. Render it inside the bordered block on the right edge.
        if self.items.len() > 1 {
            frame.render_stateful_widget(
                Scrollbar::new(ScrollbarOrientation::VerticalRight)
                    .begin_symbol(Some(""))
                    .end_symbol(Some("")),
                area.inner(Margin {
                    vertical: 1,
                    horizontal: 0,
                }),
                &mut self.scroll_state,
            );
        }
    }

    fn render_footer(&self, f: &mut Frame, area: Rect) {
        f.render_widget(
            Paragraph::new(format!(
                "{}\n{ALL_HELP}",
                match self.input_state {
                    InputState::Duration => DURATION_TEXT,
                    InputState::Justification => JUSTIFICATION_TEXT,
                    InputState::Scopes => SCOPE_TEXT,
                }
            ))
            .style(Style::new())
            .centered()
            .block(
                Block::bordered()
                    .title("Help")
                    .border_type(BorderType::Double)
                    .border_style(Style::new()),
            ),
            area,
        );
    }

    fn run<B: Backend>(mut self, terminal: &mut Terminal<B>) -> Result<Option<Selected>> {
        self.check();
        loop {
            terminal
                .draw(|f| self.draw(f))
                .map_err(|e| anyhow!("Failed to draw terminal: {e}"))?;

            if let Event::Key(key) = event::read()? {
                if key.kind == KeyEventKind::Press {
                    match (self.input_state, key.code) {
                        (InputState::Justification, Tab) | (InputState::Duration, BackTab) => {
                            self.input_state = InputState::Scopes;
                        }
                        (InputState::Scopes, Tab) | (InputState::Justification, BackTab) => {
                            self.input_state = InputState::Duration;
                        }
                        (InputState::Duration, Tab) | (InputState::Scopes, BackTab) => {
                            self.input_state = InputState::Justification;
                        }
                        (InputState::Justification, Char(c)) => {
                            if let Some(justification) = &mut self.justification {
                                justification.push(c);
                            }
                        }
                        (InputState::Justification, Backspace) => {
                            if let Some(justification) = &mut self.justification {
                                justification.pop();
                            }
                        }
                        (InputState::Duration, Down) => {
                            self.duration = self.duration.map(|x| x.saturating_sub(1).max(1));
                        }
                        (InputState::Duration, Up) => {
                            self.duration = self.duration.map(|x| x.saturating_add(1).min(480));
                        }
                        (InputState::Scopes, Char(' ')) => self.toggle_current(),
                        (InputState::Scopes, Down) => self.next(),
                        (InputState::Scopes, Up) => self.previous(),
                        (_, Esc) => return Ok(None),
                        (_, Enter) if self.warnings.is_empty() => {
                            let assignments = self
                                .items
                                .into_iter()
                                .filter(|entry| entry.enabled)
                                .map(|entry| entry.value)
                                .collect();
                            return Ok(Some(Selected {
                                assignments,
                                justification: self.justification.unwrap_or_default(),
                                duration: self.duration.unwrap_or_default(),
                            }));
                        }
                        _ => {}
                    }
                }
            }
            self.check();
        }
    }
}

pub fn interactive_ui(
    items: BTreeSet<RoleAssignment>,
    justification: Option<String>,
    duration: Option<u64>,
) -> Result<Option<Selected>> {
    // setup terminal
    enable_raw_mode()?;
    let mut stdout = stdout();
    execute!(stdout, EnterAlternateScreen)?;
    let backend = CrosstermBackend::new(stdout);
    let mut terminal = Terminal::new(backend)?;

    // create app and run it
    let app = App::new(items, justification, duration)?;
    let res = app.run(&mut terminal);

    // restore terminal
    disable_raw_mode()?;
    execute!(terminal.backend_mut(), LeaveAlternateScreen,)?;
    terminal.show_cursor()?;

    res
}

fn column_widths(items: &BTreeSet<RoleAssignment>) -> Result<(u16, u16)> {
    let (scope_name_len, role_len, scope_len) =
        items
            .iter()
            .fold((0, 0, 0), |(scope_name_len, role_len, scope_len), x| {
                (
                    scope_name_len.max(x.scope_name.as_deref().map_or(0, str::len)),
                    role_len.max(x.role.0.len()),
                    scope_len.max(x.scope.0.len()),
                )
            });

    Ok((
        role_len.try_into()?,
        scope_name_len.max(scope_len).try_into()?,
    ))
}

/// Wrap `text` to lines no wider than `width` columns, breaking on whitespace
/// where possible and falling back to hard breaks for long unbroken runs (such
/// as Azure scope paths).
fn wrap_text(text: &str, width: u16) -> Vec<String> {
    let width = usize::from(width.max(1));
    let mut out = Vec::new();
    for line in text.split('\n') {
        if line.is_empty() {
            out.push(String::new());
            continue;
        }
        let mut current = String::new();
        for word in line.split_inclusive(char::is_whitespace) {
            if current.chars().count() + word.chars().count() <= width {
                current.push_str(word);
                continue;
            }
            if !current.is_empty() {
                out.push(std::mem::take(&mut current));
            }
            // Hard-break any single token longer than the column width.
            let mut chunk = String::new();
            for ch in word.chars() {
                if chunk.chars().count() == width {
                    out.push(std::mem::take(&mut chunk));
                }
                chunk.push(ch);
            }
            current = chunk;
        }
        out.push(current);
    }
    out
}

#[cfg(test)]
mod tests {
    use super::wrap_text;

    #[test]
    fn wrap_short_text_unchanged() {
        assert_eq!(wrap_text("hello", 80), vec!["hello".to_string()]);
    }

    #[test]
    fn wrap_breaks_on_whitespace() {
        assert_eq!(
            wrap_text("one two three four", 8),
            vec![
                "one two ".to_string(),
                "three ".to_string(),
                "four".to_string()
            ],
        );
    }

    #[test]
    fn wrap_hard_breaks_long_token() {
        let scope = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg";
        let wrapped = wrap_text(scope, 20);
        assert!(wrapped.iter().all(|l| l.chars().count() <= 20));
        assert_eq!(wrapped.concat(), scope);
    }

    #[test]
    fn wrap_preserves_explicit_newlines() {
        let wrapped = wrap_text("name\n/path/to/scope", 40);
        assert_eq!(
            wrapped,
            vec!["name".to_string(), "/path/to/scope".to_string()]
        );
    }
}