desox 0.5.1

(incomplete) MIFARE DESFire EV3 APDU bindings.
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

// {{{ Copyright (c) Paul R. Tagliamonte <paultag@gmail.com>, 2026
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE. }}}

#![deny(missing_docs)]
#![deny(missing_copy_implementations)]
#![deny(trivial_casts)]
#![deny(trivial_numeric_casts)]
#![deny(unused_import_braces)]
#![deny(unused_qualifications)]
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_intra_doc_links)]
#![cfg_attr(not(any(test, feature = "std")), no_std)]

//! DESOx is a (very basic and partial!) implementaiton of the MIFARE DESFire
//! protocol. This protocol has a number of public implementations that I've
//! studied, but the actual documentation is under NDA, which I have not signed.
//!
//! This crate will (likely forever?) be partial, incomplete, and filled with
//! nasal demons -- but the only goal is to reliably do the "basics".

extern crate alloc;

mod card;
mod card_authenticated;
mod card_default;
mod card_unauthenticated;
mod cmd_applications;
mod cmd_authenticate;
mod cmd_card_version;
mod cmd_file;
mod cmd_file_data;
mod cmd_format_card;
mod cmd_key;
mod cmd_real_uid;
mod copy_to_slice;
mod crc;
mod crypto;
mod error;
mod file;
mod handshake;
mod instruction;
mod key;
mod key_count;
mod keying;
mod padding;
#[cfg(feature = "pcsc")]
mod pcsc;
mod permissions;
#[cfg(test)]
mod replay;
mod session;
mod status_code;
mod transport_backend;
mod u24;
mod version_info;

pub mod io;

use card::{
    command, command_cmac_de_minimis, command_de_minimis, command_encrypted_request_de_minimis,
    command_encrypted_response, command_encrypted_response_de_minimis, command_header,
};
use copy_to_slice::CopyToSlice;
use crc::crc32;
use padding::Padding;
use u24::U24;

pub(crate) use handshake::AuthenticateExt;

pub use card::{AuthenticationState, Card};
pub use card_authenticated::Authenticated;
pub use card_default::CardIoDefault;
pub use card_unauthenticated::Unauthenticated;
pub use cmd_file_data::FileIo;
pub use error::Error;
pub use file::{FileCommunication, FilePermissions, FileSettings, FileType};
pub use instruction::Instruction;
pub use key::Key;
pub use key_count::KeyCount;
pub use keying::KeyingState;
pub use permissions::{AppPermissions, KeyPermissions, Permissions};
pub use session::Session;
pub use status_code::StatusCode;
pub use transport_backend::TransportBackend;
pub use version_info::{DetailedVersionInfo, VersionInfo};

/// Type alias for a card which is currently unauthenticated.
pub type UnauthenticatedCard<IoBackend> = Card<IoBackend, Unauthenticated>;

/// Type alias for a card which is currently authenticated.
pub type AuthenticatedCard<IoBackend> = Card<IoBackend, Authenticated>;

/// MIFARE DESFire Cards all have a Unique ID ([Uid]). UIDs are 7 bytes long,
/// and are generally only readable after authentication.
pub type Uid = [u8; 7];

/// MiFare DESFire Cards can have a number of "applications", identified by
/// an [ApplicationId]. These IDs are unique within a Card (or I guess more
/// specifically, a Card ecosystem), used to create a logical group of Files,
/// Keys and access control to serve the needs of the system.
pub type ApplicationId = [u8; 3];

/// MIFARE DESFire Cards have a number of key slot(s). The card itself - what
/// I usually call the PICC in this source ('Proximity Integrated Circuit Card')
/// has one PICC Key (their docs call it a 'Master Key') for card-wide
/// administrative actions, as well as a number (up to 15) Application Keys.
pub type KeyId = u8;

/// MIFARE DESFire Applications may contain "Files". A File may be of a given
/// type ('data', etc), from 0x00 to 0x1F (inclusive).
pub type FileId = u8;

pub(crate) mod std {
    pub use ::alloc::fmt;
    pub use ::alloc::vec;
    pub use ::core::convert;
    pub use ::core::future;
    pub use ::core::marker;
    pub use ::core::mem;
    pub use ::core::ops;
    pub use ::core::sync;
}

// vim: foldmethod=marker