app-server: add Windows device key provider

Device keys need to prove possession with non-exportable key material on every accepted signing flow. Windows should use the platform TPM-backed key provider instead of a software secret store or keyring-style storage, so the private key stays behind the OS crypto boundary.

- Wire the device-key crate's default provider to a Windows-specific implementation on Windows.
- Create and open persistent ECDSA P-256 keys with CNG's Microsoft Platform Crypto Provider.
- Export the public key as SPKI DER by converting the CNG ECC public blob to SEC1 form.
- Sign the accepted payload digest with NCrypt and return DER-encoded ECDSA signatures.
- Preserve the hardware TPM protection class and fail create/load/sign when the platform provider or key is unavailable.

- cargo test -p codex-device-key
- cargo check -p codex-device-key --target x86_64-pc-windows-msvc
- just fix -p codex-device-key
- git diff --check
This commit is contained in:
Ruslan Nigmatullin
2026-04-21 10:10:50 -07:00
parent 3661fcf49f
commit 848e94ed60
4 changed files with 481 additions and 39 deletions
+2
View File
@@ -2131,8 +2131,10 @@ dependencies = [
"rand 0.9.3",
"serde",
"serde_json",
"sha2",
"thiserror 2.0.18",
"url",
"windows-sys 0.52.0",
]
[[package]]
+7
View File
@@ -16,5 +16,12 @@ serde_json = { workspace = true }
thiserror = { workspace = true }
url = { workspace = true }
[target.'cfg(windows)'.dependencies]
sha2 = { workspace = true }
windows-sys = { version = "0.52", features = [
"Win32_Foundation",
"Win32_Security_Cryptography",
] }
[dev-dependencies]
pretty_assertions = { workspace = true }
+56 -39
View File
@@ -1,51 +1,68 @@
use crate::DeviceKeyBinding;
use crate::DeviceKeyError;
use crate::DeviceKeyInfo;
use crate::DeviceKeyProtectionClass;
use crate::DeviceKeyProvider;
use crate::ProviderCreateRequest;
use crate::ProviderSignature;
use std::sync::Arc;
#[cfg(windows)]
mod windows;
#[cfg(windows)]
pub(crate) fn default_provider() -> Arc<dyn DeviceKeyProvider> {
Arc::new(UnsupportedDeviceKeyProvider)
Arc::new(windows::WindowsDeviceKeyProvider)
}
#[derive(Debug)]
pub(crate) struct UnsupportedDeviceKeyProvider;
#[cfg(not(windows))]
pub(crate) fn default_provider() -> Arc<dyn DeviceKeyProvider> {
Arc::new(unsupported::UnsupportedDeviceKeyProvider)
}
impl DeviceKeyProvider for UnsupportedDeviceKeyProvider {
fn create(&self, request: ProviderCreateRequest<'_>) -> Result<DeviceKeyInfo, DeviceKeyError> {
let _ = request.key_id_for(DeviceKeyProtectionClass::HardwareTpm);
let _ = request
.protection_policy
.allows(DeviceKeyProtectionClass::HardwareTpm);
let _ = request.binding;
Err(DeviceKeyError::HardwareBackedKeysUnavailable)
}
#[cfg(not(windows))]
mod unsupported {
use crate::DeviceKeyBinding;
use crate::DeviceKeyError;
use crate::DeviceKeyInfo;
use crate::DeviceKeyProtectionClass;
use crate::DeviceKeyProvider;
use crate::ProviderCreateRequest;
use crate::ProviderSignature;
fn get_public(
&self,
_key_id: &str,
_protection_class: DeviceKeyProtectionClass,
) -> Result<DeviceKeyInfo, DeviceKeyError> {
Err(DeviceKeyError::KeyNotFound)
}
#[derive(Debug)]
pub(crate) struct UnsupportedDeviceKeyProvider;
fn binding(
&self,
_key_id: &str,
_protection_class: DeviceKeyProtectionClass,
) -> Result<DeviceKeyBinding, DeviceKeyError> {
Err(DeviceKeyError::KeyNotFound)
}
impl DeviceKeyProvider for UnsupportedDeviceKeyProvider {
fn create(
&self,
request: ProviderCreateRequest<'_>,
) -> Result<DeviceKeyInfo, DeviceKeyError> {
let _ = request.key_id_for(DeviceKeyProtectionClass::HardwareTpm);
let _ = request
.protection_policy
.allows(DeviceKeyProtectionClass::HardwareTpm);
let _ = request.binding;
Err(DeviceKeyError::HardwareBackedKeysUnavailable)
}
fn sign(
&self,
_key_id: &str,
_protection_class: DeviceKeyProtectionClass,
_payload: &[u8],
) -> Result<ProviderSignature, DeviceKeyError> {
Err(DeviceKeyError::KeyNotFound)
fn get_public(
&self,
_key_id: &str,
_protection_class: DeviceKeyProtectionClass,
) -> Result<DeviceKeyInfo, DeviceKeyError> {
Err(DeviceKeyError::KeyNotFound)
}
fn binding(
&self,
_key_id: &str,
_protection_class: DeviceKeyProtectionClass,
) -> Result<DeviceKeyBinding, DeviceKeyError> {
Err(DeviceKeyError::KeyNotFound)
}
fn sign(
&self,
_key_id: &str,
_protection_class: DeviceKeyProtectionClass,
_payload: &[u8],
) -> Result<ProviderSignature, DeviceKeyError> {
Err(DeviceKeyError::KeyNotFound)
}
}
}
+416
View File
@@ -0,0 +1,416 @@
use crate::DeviceKeyAlgorithm;
use crate::DeviceKeyBinding;
use crate::DeviceKeyError;
use crate::DeviceKeyInfo;
use crate::DeviceKeyProtectionClass;
use crate::DeviceKeyProvider;
use crate::ProviderCreateRequest;
use crate::ProviderSignature;
use crate::sec1_public_key_to_spki_der;
use p256::ecdsa::Signature;
use serde::Deserialize;
use serde::Serialize;
use sha2::Digest;
use sha2::Sha256;
use std::fs;
use std::mem::size_of;
use std::path::PathBuf;
use std::ptr;
use windows_sys::Win32::Foundation::NTE_BAD_KEYSET;
use windows_sys::Win32::Foundation::NTE_EXISTS;
use windows_sys::Win32::Security::Cryptography::BCRYPT_ECCKEY_BLOB;
use windows_sys::Win32::Security::Cryptography::BCRYPT_ECCPUBLIC_BLOB;
use windows_sys::Win32::Security::Cryptography::BCRYPT_ECDSA_PUBLIC_P256_MAGIC;
use windows_sys::Win32::Security::Cryptography::MS_PLATFORM_CRYPTO_PROVIDER;
use windows_sys::Win32::Security::Cryptography::NCRYPT_ECDSA_P256_ALGORITHM;
use windows_sys::Win32::Security::Cryptography::NCRYPT_HANDLE;
use windows_sys::Win32::Security::Cryptography::NCRYPT_KEY_HANDLE;
use windows_sys::Win32::Security::Cryptography::NCRYPT_PROV_HANDLE;
use windows_sys::Win32::Security::Cryptography::NCRYPT_SILENT_FLAG;
use windows_sys::Win32::Security::Cryptography::NCryptCreatePersistedKey;
use windows_sys::Win32::Security::Cryptography::NCryptExportKey;
use windows_sys::Win32::Security::Cryptography::NCryptFinalizeKey;
use windows_sys::Win32::Security::Cryptography::NCryptFreeObject;
use windows_sys::Win32::Security::Cryptography::NCryptOpenKey;
use windows_sys::Win32::Security::Cryptography::NCryptOpenStorageProvider;
use windows_sys::Win32::Security::Cryptography::NCryptSignHash;
use windows_sys::core::HRESULT;
#[derive(Debug)]
pub(crate) struct WindowsDeviceKeyProvider;
impl DeviceKeyProvider for WindowsDeviceKeyProvider {
fn create(&self, request: ProviderCreateRequest<'_>) -> Result<DeviceKeyInfo, DeviceKeyError> {
if !request
.protection_policy
.allows(DeviceKeyProtectionClass::HardwareTpm)
{
return Err(DeviceKeyError::DegradedProtectionNotAllowed {
available: DeviceKeyProtectionClass::HardwareTpm,
});
}
let key_id = request.key_id_for(DeviceKeyProtectionClass::HardwareTpm);
let provider = open_platform_provider()?;
let name = key_name(&key_id);
if let Some(key) = open_key(&provider, &name)? {
let info = key_info(&key_id, &key)?;
store_binding(&key_id, request.binding)?;
return Ok(info);
}
let key = create_or_open_key(&provider, &name)?;
let info = key_info(&key_id, &key)?;
store_binding(&key_id, request.binding)?;
Ok(info)
}
fn get_public(
&self,
key_id: &str,
protection_class: DeviceKeyProtectionClass,
) -> Result<DeviceKeyInfo, DeviceKeyError> {
require_hardware_tpm(protection_class)?;
let provider = open_platform_provider()?;
let key = open_key(&provider, &key_name(key_id))?.ok_or(DeviceKeyError::KeyNotFound)?;
key_info(key_id, &key)
}
fn binding(
&self,
key_id: &str,
protection_class: DeviceKeyProtectionClass,
) -> Result<DeviceKeyBinding, DeviceKeyError> {
require_hardware_tpm(protection_class)?;
load_binding(key_id)
}
fn sign(
&self,
key_id: &str,
protection_class: DeviceKeyProtectionClass,
payload: &[u8],
) -> Result<ProviderSignature, DeviceKeyError> {
require_hardware_tpm(protection_class)?;
let provider = open_platform_provider()?;
let key = open_key(&provider, &key_name(key_id))?.ok_or(DeviceKeyError::KeyNotFound)?;
let digest = Sha256::digest(payload);
let signature = sign_hash(&key, &digest)?;
let signature = Signature::from_slice(&signature)
.map_err(|err| DeviceKeyError::Crypto(err.to_string()))?;
Ok(ProviderSignature {
signature_der: signature.to_der().as_bytes().to_vec(),
algorithm: DeviceKeyAlgorithm::EcdsaP256Sha256,
})
}
}
fn require_hardware_tpm(protection_class: DeviceKeyProtectionClass) -> Result<(), DeviceKeyError> {
if protection_class != DeviceKeyProtectionClass::HardwareTpm {
return Err(DeviceKeyError::KeyNotFound);
}
Ok(())
}
#[derive(Debug)]
struct ProviderHandle(NCRYPT_PROV_HANDLE);
impl Drop for ProviderHandle {
fn drop(&mut self) {
unsafe {
NCryptFreeObject(self.0 as NCRYPT_HANDLE);
}
}
}
#[derive(Debug)]
struct KeyHandle(NCRYPT_KEY_HANDLE);
impl Drop for KeyHandle {
fn drop(&mut self) {
unsafe {
NCryptFreeObject(self.0 as NCRYPT_HANDLE);
}
}
}
fn open_platform_provider() -> Result<ProviderHandle, DeviceKeyError> {
let mut provider = 0;
let status = unsafe {
NCryptOpenStorageProvider(
&mut provider,
MS_PLATFORM_CRYPTO_PROVIDER,
/*dwflags*/ 0,
)
};
if status != 0 {
return Err(DeviceKeyError::HardwareBackedKeysUnavailable);
}
Ok(ProviderHandle(provider))
}
fn open_key(provider: &ProviderHandle, name: &[u16]) -> Result<Option<KeyHandle>, DeviceKeyError> {
let mut key = 0;
let status = unsafe {
NCryptOpenKey(
provider.0,
&mut key,
name.as_ptr(),
/*dwlegacykeyspec*/ 0,
NCRYPT_SILENT_FLAG,
)
};
if status == NTE_BAD_KEYSET {
return Ok(None);
}
if status != 0 {
return Err(DeviceKeyError::Platform(format_hresult(
"NCryptOpenKey",
status,
)));
}
Ok(Some(KeyHandle(key)))
}
fn create_or_open_key(
provider: &ProviderHandle,
name: &[u16],
) -> Result<KeyHandle, DeviceKeyError> {
match create_key(provider, name) {
Ok(key) => Ok(key),
Err(KeyCreationError::AlreadyExists) => {
open_key(provider, name)?.ok_or(DeviceKeyError::KeyNotFound)
}
Err(KeyCreationError::Failed(err)) => Err(err),
}
}
enum KeyCreationError {
AlreadyExists,
Failed(DeviceKeyError),
}
fn create_key(provider: &ProviderHandle, name: &[u16]) -> Result<KeyHandle, KeyCreationError> {
let mut key = 0;
let status = unsafe {
NCryptCreatePersistedKey(
provider.0,
&mut key,
NCRYPT_ECDSA_P256_ALGORITHM,
name.as_ptr(),
/*dwlegacykeyspec*/ 0,
NCRYPT_SILENT_FLAG,
)
};
if status == NTE_EXISTS {
return Err(KeyCreationError::AlreadyExists);
}
if status != 0 {
return Err(KeyCreationError::Failed(DeviceKeyError::Platform(
format_hresult("NCryptCreatePersistedKey", status),
)));
}
let key = KeyHandle(key);
let status = unsafe { NCryptFinalizeKey(key.0, NCRYPT_SILENT_FLAG) };
if status != 0 {
return Err(KeyCreationError::Failed(DeviceKeyError::Platform(
format_hresult("NCryptFinalizeKey", status),
)));
}
Ok(key)
}
fn key_info(key_id: &str, key: &KeyHandle) -> Result<DeviceKeyInfo, DeviceKeyError> {
Ok(DeviceKeyInfo {
key_id: key_id.to_string(),
public_key_spki_der: export_public_key_spki_der(key)?,
algorithm: DeviceKeyAlgorithm::EcdsaP256Sha256,
protection_class: DeviceKeyProtectionClass::HardwareTpm,
})
}
fn export_public_key_spki_der(key: &KeyHandle) -> Result<Vec<u8>, DeviceKeyError> {
let blob = ncrypt_export_key(key, BCRYPT_ECCPUBLIC_BLOB)?;
let header_len = size_of::<BCRYPT_ECCKEY_BLOB>();
if blob.len() < header_len {
return Err(DeviceKeyError::Platform(
"NCryptExportKey returned a truncated ECC public key header".to_string(),
));
}
let header = unsafe { ptr::read_unaligned(blob.as_ptr() as *const BCRYPT_ECCKEY_BLOB) };
if header.dwMagic != BCRYPT_ECDSA_PUBLIC_P256_MAGIC {
return Err(DeviceKeyError::Platform(format!(
"NCryptExportKey returned unsupported ECC public key magic {}",
header.dwMagic
)));
}
let coordinate_len =
usize::try_from(header.cbKey).map_err(|err| DeviceKeyError::Platform(err.to_string()))?;
let expected_len = header_len + coordinate_len * 2;
if blob.len() != expected_len {
return Err(DeviceKeyError::Platform(format!(
"NCryptExportKey returned ECC public key length {}, expected {expected_len}",
blob.len()
)));
}
let mut sec1 = Vec::with_capacity(1 + coordinate_len * 2);
sec1.push(0x04);
sec1.extend_from_slice(&blob[header_len..]);
sec1_public_key_to_spki_der(&sec1)
}
fn sign_hash(key: &KeyHandle, digest: &[u8]) -> Result<Vec<u8>, DeviceKeyError> {
let mut len = 0;
let status = unsafe {
NCryptSignHash(
key.0,
ptr::null(),
digest.as_ptr(),
digest.len() as u32,
ptr::null_mut(),
/*cbsignature*/ 0,
&mut len,
NCRYPT_SILENT_FLAG,
)
};
if status != 0 {
return Err(DeviceKeyError::Platform(format_hresult(
"NCryptSignHash",
status,
)));
}
let mut signature = vec![0; len as usize];
let status = unsafe {
NCryptSignHash(
key.0,
ptr::null(),
digest.as_ptr(),
digest.len() as u32,
signature.as_mut_ptr(),
signature.len() as u32,
&mut len,
NCRYPT_SILENT_FLAG,
)
};
if status != 0 {
return Err(DeviceKeyError::Platform(format_hresult(
"NCryptSignHash",
status,
)));
}
signature.truncate(len as usize);
Ok(signature)
}
fn ncrypt_export_key(key: &KeyHandle, blob_type: *const u16) -> Result<Vec<u8>, DeviceKeyError> {
let mut len = 0;
let status = unsafe {
NCryptExportKey(
key.0,
/*hexportkey*/ 0,
blob_type,
ptr::null(),
ptr::null_mut(),
/*cboutput*/ 0,
&mut len,
NCRYPT_SILENT_FLAG,
)
};
if status != 0 {
return Err(DeviceKeyError::Platform(format_hresult(
"NCryptExportKey",
status,
)));
}
let mut blob = vec![0; len as usize];
let status = unsafe {
NCryptExportKey(
key.0,
/*hexportkey*/ 0,
blob_type,
ptr::null(),
blob.as_mut_ptr(),
blob.len() as u32,
&mut len,
NCRYPT_SILENT_FLAG,
)
};
if status != 0 {
return Err(DeviceKeyError::Platform(format_hresult(
"NCryptExportKey",
status,
)));
}
blob.truncate(len as usize);
Ok(blob)
}
fn key_name(key_id: &str) -> Vec<u16> {
format!("CodexDeviceKey.{key_id}")
.encode_utf16()
.chain(std::iter::once(0))
.collect()
}
#[derive(Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
struct StoredBinding {
account_user_id: String,
client_id: String,
}
fn store_binding(key_id: &str, binding: &DeviceKeyBinding) -> Result<(), DeviceKeyError> {
let path = binding_path(key_id)?;
let parent = path
.parent()
.ok_or_else(|| DeviceKeyError::Platform("binding path has no parent".to_string()))?;
fs::create_dir_all(parent).map_err(|err| DeviceKeyError::Platform(err.to_string()))?;
let stored = StoredBinding {
account_user_id: binding.account_user_id.clone(),
client_id: binding.client_id.clone(),
};
let bytes =
serde_json::to_vec(&stored).map_err(|err| DeviceKeyError::Platform(err.to_string()))?;
fs::write(path, bytes).map_err(|err| DeviceKeyError::Platform(err.to_string()))
}
fn load_binding(key_id: &str) -> Result<DeviceKeyBinding, DeviceKeyError> {
let path = binding_path(key_id)?;
let bytes = fs::read(path).map_err(|err| {
if err.kind() == std::io::ErrorKind::NotFound {
DeviceKeyError::KeyNotFound
} else {
DeviceKeyError::Platform(err.to_string())
}
})?;
let stored: StoredBinding =
serde_json::from_slice(&bytes).map_err(|err| DeviceKeyError::Platform(err.to_string()))?;
Ok(DeviceKeyBinding {
account_user_id: stored.account_user_id,
client_id: stored.client_id,
})
}
fn binding_path(key_id: &str) -> Result<PathBuf, DeviceKeyError> {
let data_dir = std::env::var_os("LOCALAPPDATA")
.or_else(|| std::env::var_os("APPDATA"))
.ok_or_else(|| {
DeviceKeyError::Platform("LOCALAPPDATA and APPDATA are not set".to_string())
})?;
Ok(PathBuf::from(data_dir)
.join("OpenAI")
.join("Codex")
.join("device-keys")
.join("windows")
.join(format!("{key_id}.binding.json")))
}
fn format_hresult(function: &str, status: HRESULT) -> String {
format!("{function} failed with HRESULT 0x{:08x}", status as u32)
}