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 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
// Copyright (c) 2020 Ivaylo Petrov
//
// Licensed under the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
//
// author: Ivaylo Petrov <ivajloip@gmail.com>
//! Provides a default software implementation for LoRaWAN's cryptographic functions.
use super::creator::JoinRequestCreator;
use super::keys::*;
use super::parser::{
DecryptedDataPayload, DecryptedJoinAcceptPayload, EncryptedDataPayload,
EncryptedJoinAcceptPayload, JoinRequestPayload,
};
use super::securityhelpers::generic_array::{typenum::U16, GenericArray};
use crate::parser::Error;
use aes::cipher::{BlockDecrypt, BlockEncrypt, KeyInit};
use aes::Aes128;
pub type Cmac = cmac::Cmac<Aes128>;
/// Provides a default implementation for build object for using the crypto functions.
#[derive(Default, Debug, PartialEq, Eq)]
pub struct DefaultFactory;
impl CryptoFactory for DefaultFactory {
type E = Aes128;
type D = Aes128;
type M = Cmac;
fn new_enc(&self, key: &AES128) -> Self::E {
Aes128::new(GenericArray::from_slice(&key.0[..]))
}
fn new_dec(&self, key: &AES128) -> Self::D {
Aes128::new(GenericArray::from_slice(&key.0[..]))
}
fn new_mac(&self, key: &AES128) -> Self::M {
let key = GenericArray::from_slice(&key.0[..]);
Cmac::new(key)
}
}
impl Encrypter for Aes128 {
fn encrypt_block(&self, block: &mut GenericArray<u8, U16>) {
BlockEncrypt::encrypt_block(self, block);
}
}
impl Decrypter for Aes128 {
fn decrypt_block(&self, block: &mut GenericArray<u8, U16>) {
BlockDecrypt::decrypt_block(self, block);
}
}
impl Mac for Cmac {
fn input(&mut self, data: &[u8]) {
cmac::Mac::update(self, data);
}
fn reset(&mut self) {
cmac::Mac::reset(self);
}
fn result(self) -> GenericArray<u8, U16> {
cmac::Mac::finalize(self).into_bytes()
}
}
impl JoinRequestCreator<[u8; 23], DefaultFactory> {
/// Creates a well initialized JoinRequestCreator.
///
/// # Examples
///
/// ```
/// let mut phy = lorawan::creator::JoinRequestCreator::new();
/// let key = lorawan::keys::AppKey::from([7; 16]);
/// phy.set_app_eui(&[1; 8]);
/// phy.set_dev_eui(&[2; 8]);
/// phy.set_dev_nonce(&[3; 2]);
/// let payload = phy.build(&key);
/// ```
pub fn new() -> Self {
Self::with_options([0; 23], DefaultFactory).unwrap()
}
}
impl<T: AsRef<[u8]>> JoinRequestPayload<T, DefaultFactory> {
/// Creates a new JoinRequestPayload if the provided data is acceptable.
///
/// # Argument
///
/// * data - the bytes for the payload.
///
/// # Examples
///
/// ```
/// let data = vec![0x00, 0x04, 0x03, 0x02, 0x01, 0x04, 0x03, 0x02, 0x01, 0x05, 0x04, 0x03,
/// 0x02, 0x05, 0x04, 0x03, 0x02, 0x2d, 0x10, 0x6a, 0x99, 0x0e, 0x12];
/// let phy = lorawan::parser::JoinRequestPayload::new(data);
/// ```
pub fn new(data: T) -> Result<Self, Error> {
Self::new_with_factory(data, DefaultFactory)
}
}
impl<T: AsRef<[u8]> + AsMut<[u8]>> EncryptedJoinAcceptPayload<T, DefaultFactory> {
/// Creates a new EncryptedJoinAcceptPayload if the provided data is acceptable.
///
/// # Argument
///
/// * data - the bytes for the payload.
///
/// # Examples
///
/// ```
/// let data = vec![0x20, 0x49, 0x3e, 0xeb, 0x51, 0xfb, 0xa2, 0x11, 0x6f, 0x81, 0x0e, 0xdb,
/// 0x37, 0x42, 0x97, 0x51, 0x42];
/// let phy = lorawan::parser::EncryptedJoinAcceptPayload::new(data);
/// ```
pub fn new(data: T) -> Result<Self, Error> {
Self::new_with_factory(data, DefaultFactory)
}
}
impl<T: AsRef<[u8]> + AsMut<[u8]>> DecryptedJoinAcceptPayload<T, DefaultFactory> {
/// Creates a DecryptedJoinAcceptPayload from the bytes of a JoinAccept.
///
/// The JoinAccept payload is automatically decrypted and the mic is verified.
///
/// # Argument
///
/// * bytes - the data from which the PhyPayload is to be built.
/// * key - the key that is to be used to decrypt the payload.
///
/// # Examples
///
/// ```
/// let mut data = vec![0x20u8, 0x49u8, 0x3eu8, 0xebu8, 0x51u8, 0xfbu8,
/// 0xa2u8, 0x11u8, 0x6fu8, 0x81u8, 0x0eu8, 0xdbu8, 0x37u8, 0x42u8,
/// 0x97u8, 0x51u8, 0x42u8];
/// let key = lorawan::keys::AppKey::from([2; 16]);
/// let phy = lorawan::parser::DecryptedJoinAcceptPayload::new(&mut data[..], &key);
/// ```
pub fn new(data: T, key: &AppKey) -> Result<Self, Error> {
Self::new_with_factory(data, key, DefaultFactory)
}
}
impl<T: AsRef<[u8]>> EncryptedDataPayload<T, DefaultFactory> {
/// Creates a PhyPayload from bytes.
///
/// # Argument
///
/// * bytes - the data from which the PhyPayload is to be built.
///
/// # Examples
///
/// ```
/// let mut data = vec![0x40, 0x04, 0x03, 0x02, 0x01, 0x80, 0x01, 0x00, 0x01,
/// 0xa6, 0x94, 0x64, 0x26, 0x15, 0xd6, 0xc3, 0xb5, 0x82];
/// let phy = lorawan::parser::EncryptedDataPayload::new(data);
/// ```
pub fn new(data: T) -> Result<Self, Error> {
Self::new_with_factory(data, DefaultFactory)
}
}
impl<T: AsRef<[u8]> + AsMut<[u8]>> DecryptedDataPayload<T> {
/// Creates a DecryptedDataPayload from the bytes of a DataPayload.
///
/// The DataPayload payload is automatically decrypted and the mic is verified.
///
/// # Argument
///
/// * nwk_skey - the Network Session key used to decrypt the mac commands in case the payload is
/// transporting those.
/// * app_skey - the Application Session key used to decrypt the application payload in case the
/// payload is transporting that.
/// * fcnt - the counter used to encrypt the payload.
///
/// # Examples
///
/// ```
/// let mut data = vec![0x40, 0x04, 0x03, 0x02, 0x01, 0x80, 0x01, 0x00, 0x01,
/// 0xa6, 0x94, 0x64, 0x26, 0x15, 0xd6, 0xc3, 0xb5, 0x82];
/// let nwk_skey = lorawan::keys::AES128([2; 16]);
/// let app_skey = lorawan::keys::AES128([1; 16]);
/// let dec_phy = lorawan::parser::DecryptedDataPayload::new(data,
/// &nwk_skey,
/// Some(&app_skey),
/// 1).unwrap();
/// ```
pub fn new<'a>(
data: T,
nwk_skey: &'a AES128,
app_skey: Option<&'a AES128>,
fcnt: u32,
) -> Result<Self, Error> {
let t = EncryptedDataPayload::new(data)?;
if !t.validate_mic(nwk_skey, fcnt) {
return Err(Error::InvalidMic);
}
t.decrypt(Some(nwk_skey), app_skey, fcnt)
}
}