ockam-ffi 0.78.0

FFI layer for ockam_vault.
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

#![allow(conflicting_repr_hints)]

use crate::FfiError;
use ockam_vault::constants::AES256_SECRET_LENGTH_U32;
use ockam_vault::{SecretAttributes, SecretType};

/// Represents a handle id for the secret key
pub type SecretKeyHandle = u64;

#[repr(C, u8)]
#[derive(Clone, Copy, Debug)]
pub enum FfiVaultType {
    Software = 1,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct FfiVaultFatPointer {
    handle: u64,
    vault_type: FfiVaultType,
}

impl FfiVaultFatPointer {
    pub fn handle(&self) -> u64 {
        self.handle
    }
    pub fn vault_type(&self) -> FfiVaultType {
        self.vault_type
    }
}

impl FfiVaultFatPointer {
    pub fn new(handle: u64, vault_type: FfiVaultType) -> Self {
        FfiVaultFatPointer { handle, vault_type }
    }
}

#[derive(Clone, Copy, Debug)]
#[repr(C)]
pub struct FfiSecretAttributes {
    stype: u8,
    persistence: u8,
    length: u32,
}

impl FfiSecretAttributes {
    pub fn stype(&self) -> u8 {
        self.stype
    }
    pub fn persistence(&self) -> u8 {
        self.persistence
    }
    pub fn length(&self) -> u32 {
        self.length
    }
}

impl FfiSecretAttributes {
    pub fn new(stype: u8, length: u32) -> Self {
        Self {
            stype,
            persistence: 0,
            length,
        }
    }
}

impl From<SecretAttributes> for FfiSecretAttributes {
    fn from(attrs: SecretAttributes) -> Self {
        let stype = match attrs.secret_type() {
            SecretType::Buffer => 0,
            SecretType::Aes => 1,
            SecretType::X25519 => 2,
            SecretType::Ed25519 => 3,
            SecretType::NistP256 => 4,
        };

        Self::new(stype, attrs.length())
    }
}

impl TryFrom<FfiSecretAttributes> for SecretAttributes {
    type Error = FfiError;

    fn try_from(attrs: FfiSecretAttributes) -> Result<Self, Self::Error> {
        match attrs.stype() {
            0 => Ok(SecretAttributes::Buffer(attrs.length)),
            1 => Ok(if attrs.length == AES256_SECRET_LENGTH_U32 {
                SecretAttributes::Aes256
            } else {
                SecretAttributes::Aes128
            }),
            2 => Ok(SecretAttributes::X25519),
            3 => Ok(SecretAttributes::Ed25519),
            _ => Err(FfiError::InvalidParam),
        }
    }
}