alibi-plugins 0.8.0

Built-in authentication plugins and API metadata for Alibi
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

use super::config::{SiweCallbackResult, SiweVerification, SiweVerifier};
use super::parse::valid_address;
use async_trait::async_trait;
use k256::ecdsa::{RecoveryId, Signature, VerifyingKey};
use k256::elliptic_curve::scalar::IsHigh;
use sha3::{Digest, Keccak256};

/// Secure EIP-191 verifier for externally owned Ethereum accounts. Contract
/// wallets can use a custom [`SiweVerifier`] backed by the application's RPC.
#[derive(Debug, Clone, Copy, Default)]
pub struct Eip191Verifier;

impl Eip191Verifier {
    /// Recover the checksummed signer from a 65-byte `r,s,v` signature or an
    /// EIP-2098 compact signature. Invalid encodings return `None`.
    #[must_use]
    pub fn recover_address(message: &str, signature: &str) -> Option<String> {
        Self::recover_hash_address(&ethereum_message_hash(message), signature)
    }

    /// Recover a personal-sign signer from its already computed digest. This
    /// supports application-owned contract-wallet and JSON-RPC integrations.
    #[must_use]
    pub fn recover_hash_address(digest: &[u8; 32], signature: &str) -> Option<String> {
        use std::fmt::Write;

        let bytes = hex_bytes(signature)?;
        let (signature_3, recovery) = match bytes.len() {
            65 => {
                let signature_2 = Signature::from_slice(bytes.get(..64)?).ok()?;
                let encoded = *bytes.get(64)?;
                let recovery = match encoded {
                    0 | 1 => encoded,
                    27 | 28 => encoded - 27,
                    _ => return None,
                };
                (signature_2, recovery)
            }
            64 => {
                let mut compact: [u8; 64] = bytes.try_into().ok()?;
                let recovery = *compact.get(32)? >> 7;
                if let Some(first) = compact.get_mut(32) {
                    *first &= 127;
                }
                (Signature::from_slice(&compact).ok()?, recovery)
            }
            _ => return None,
        };
        // Reject noncanonical signatures rather than allowing an alternative
        // high-S encoding to bypass the verifier's signature policy.
        if signature_3.s().is_high().into() {
            return None;
        }
        let key = VerifyingKey::recover_from_prehash(
            digest,
            &signature_3,
            RecoveryId::try_from(recovery).ok()?,
        )
        .ok()?;
        let public_key = key.to_sec1_point(false);
        let hash = Keccak256::digest(public_key.as_bytes().get(1..)?);
        let mut address = String::from("0x");

        for byte in hash.get(12..)? {
            write!(address, "{byte:02x}").ok()?;
        }
        checksum_address(&address)
    }
}

#[async_trait]
impl SiweVerifier for Eip191Verifier {
    async fn verify_message(&self, input: SiweVerification) -> SiweCallbackResult<bool> {
        Ok(Self::recover_address(&input.message, &input.signature)
            .is_some_and(|address| address == input.address))
    }
}

/// EIP-191 personal-sign message digest. The prefix uses the UTF-8 byte count,
/// including any non-ASCII statement or SIWE field in the original message.
#[must_use]
pub fn ethereum_message_hash(message: &str) -> [u8; 32] {
    let mut digest = Keccak256::new();
    digest.update(b"\x19Ethereum Signed Message:\n");
    digest.update(message.len().to_string().as_bytes());
    digest.update(message.as_bytes());
    digest.finalize().into()
}

pub(super) fn checksum_address(address: &str) -> Option<String> {
    if !valid_address(address) {
        return None;
    }
    let lower = address.get(2..)?.to_ascii_lowercase();
    let digest = Keccak256::digest(lower.as_bytes());
    let mut checksum = String::from("0x");
    for (index, character) in lower.bytes().enumerate() {
        let byte = *digest.get(index / 2)?;
        let nibble = if index % 2 == 0 { byte >> 4 } else { byte & 15 };
        checksum.push(char::from(if nibble >= 8 {
            character.to_ascii_uppercase()
        } else {
            character
        }));
    }
    Some(checksum)
}

fn hex_bytes(value: &str) -> Option<Vec<u8>> {
    let value = value.strip_prefix("0x")?;
    if !value.len().is_multiple_of(2) {
        return None;
    }
    value
        .as_bytes()
        .as_chunks::<2>()
        .0
        .iter()
        .map(|pair| {
            let upper = char::from(*pair.first()?).to_digit(16)?;
            let lower = char::from(*pair.get(1)?).to_digit(16)?;
            u8::try_from((upper << 4) | lower).ok()
        })
        .collect()
}