rite-ls 0.2.2

Language server for the Rite ceremony DSL
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

//! Static metadata for all ActionType variants.
//!
//! Single source of truth for action names, short descriptions (completion popups),
//! and long descriptions (hover tooltips). Update when `ActionType` changes.
//!
//! Kept as a plain static list rather than generated from the enum to avoid
//! adding proc-macro or strum dependencies.

pub struct ActionMeta {
    pub name: &'static str,
    /// Short description shown in completion popups.
    pub short: &'static str,
    /// Full description shown in hover tooltips.
    pub long: &'static str,
}

pub static ALL: &[ActionMeta] = &[
    ActionMeta {
        name: "clock_check",
        short: "Verify system clock is correct before ceremony proceeds",
        long: "Verify system clock is correct before ceremony proceeds. Displays current time and requires operator confirmation.",
    },
    ActionMeta {
        name: "confirm",
        short: "Human attests to something with yes/no decision (single person)",
        long: "Human attests to something with yes/no decision (single person). Use when the verification requires human judgment about external state.",
    },
    ActionMeta {
        name: "check_value",
        short: "Machine compares two known values and records pass/fail (automatic)",
        long: "Machine compares two known values and records pass/fail (automatic). Use when both values are known to the system and comparison is deterministic.",
    },
    ActionMeta {
        name: "oral_readback",
        short: "Two-party verbal verification: reader speaks, confirmer verifies",
        long: "Two-party verbal verification: reader speaks value aloud, confirmer verifies. Supports NATO phonetic alphabet and hex formatting.",
    },
    ActionMeta {
        name: "machine_info",
        short: "Capture machine information (hostname, CPU, OS) as evidence",
        long: "Capture machine information (hostname, CPU, OS) as evidence. Records device identity to prove which machine ran the ceremony.",
    },
    ActionMeta {
        name: "generate_keypair",
        short: "Generate RSA or EC keypair",
        long: "Generate RSA or EC keypair.",
    },
    ActionMeta {
        name: "wrap_key",
        short: "Wrap key using CMS EnvelopedData",
        long: "Wrap key using CMS EnvelopedData.",
    },
    ActionMeta {
        name: "unwrap_key",
        short: "Unwrap key using CMS EnvelopedData",
        long: "Unwrap key using CMS EnvelopedData.",
    },
    ActionMeta {
        name: "export_public",
        short: "Export public key from keypair",
        long: "Export public key from keypair.",
    },
    ActionMeta {
        name: "attest",
        short: "Formal attestation statement",
        long: "Formal attestation statement.",
    },
    ActionMeta {
        name: "tpm_attest",
        short: "TPM attestation with PCR measurements and cryptographic quotes",
        long: "TPM attestation with PCR measurements and cryptographic quotes. Requires --features=tpm. Provides hardware-backed proof of software state and device identity.",
    },
    ActionMeta {
        name: "piv_read_certificate",
        short: "Read X.509 certificate from PIV smart card slot",
        long: "Read X.509 certificate from PIV smart card slot. No PIN required; reading certificates is unauthenticated on PIV cards.",
    },
    ActionMeta {
        name: "piv_sign",
        short: "Sign data using PIV smart card on-device key",
        long: "Sign data using PIV smart card on-device key. Handles PIN verification internally before signing.",
    },
    ActionMeta {
        name: "yubikey_attest_slot",
        short: "Generate YubiKey attestation certificate for a PIV slot",
        long: "Generate a YubiKey attestation certificate for a PIV slot (Yubico extension). Slot F9 signs the key's certificate to prove it was generated on-device.",
    },
    ActionMeta {
        name: "issue_certificate",
        short: "Issue an X.509 certificate from a PKCS#10 CSR",
        long: "Issue an X.509 certificate from a PKCS#10 CSR. Takes a CSR and a backend-managed signing key, assembles the TBSCertificate, signs via the backend.",
    },
    ActionMeta {
        name: "generate_csr",
        short: "Generate a PKCS#10 CSR signed by a backend-managed key",
        long: "Generate a PKCS#10 CSR signed by a backend-managed key. Takes a backend-managed signing key and subject parameters, assembles and signs a CertReqInfo.",
    },
];

/// Look up the hover description for a known action name.
pub fn hover_description(name: &str) -> Option<&'static str> {
    ALL.iter().find(|a| a.name == name).map(|a| a.long)
}