Skip to content

Commit

Permalink
Bump MSRV to 1.81 (#582)
Browse files Browse the repository at this point in the history
This is required due to the `hybrid-array` crate, which has become a
transitive dependency of the majority of our dependencies and will be
required in the very near future.
  • Loading branch information
str4d authored Nov 25, 2024
1 parent 0a90dc3 commit 32cd92a
Show file tree
Hide file tree
Showing 13 changed files with 50 additions and 64 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ jobs:
toolchain: stable
deps: true
- platform: ubuntu-latest
toolchain: 1.74.0 # MSRV
toolchain: 1.81.0 # MSRV
deps: sudo apt-get install libpcsclite-dev
- platform: windows-latest
toolchain: 1.74.0 # MSRV
toolchain: 1.81.0 # MSRV
deps: true
- platform: macos-latest
toolchain: 1.74.0 # MSRV
toolchain: 1.81.0 # MSRV
deps: true
runs-on: ${{ matrix.platform }}
steps:
Expand Down Expand Up @@ -82,7 +82,7 @@ jobs:
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: 1.74.0 # MSRV
toolchain: 1.81.0 # MSRV
components: clippy
override: true
- run: sudo apt-get install libpcsclite-dev
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased
### Changed
- MSRV is now 1.81.

## 0.8.0 (2023-08-15)
### Added
- `impl Debug for {Context, YubiKey}` ([#457])
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ readme = "README.md"
categories = ["api-bindings", "authentication", "cryptography", "hardware-support"]
keywords = ["ecdsa", "encryption", "rsa", "piv", "signature"]
edition = "2021"
rust-version = "1.65"
rust-version = "1.81"

[workspace]
members = [".", "cli"]
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ or conditions.
[docs-link]: https://docs.rs/yubikey/
[license-image]: https://img.shields.io/badge/license-BSD-blue.svg
[license-link]: https://github.com/iqlusioninc/yubikey.rs/blob/main/COPYING
[msrv-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
[msrv-image]: https://img.shields.io/badge/rustc-1.81+-blue.svg
[safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
[safety-link]: https://github.com/rust-secure-code/safety-dance/
[build-image]: https://github.com/iqlusioninc/yubikey.rs/workflows/CI/badge.svg?branch=main&event=push
Expand Down
4 changes: 4 additions & 0 deletions cli/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased
### Changed
- MSRV is now 1.81.

## 0.7.0 (2022-11-14)
### Changed
- Bump `clap` to v4.0 ([#438])
Expand Down
2 changes: 1 addition & 1 deletion cli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ readme = "README.md"
categories = ["command-line-utilities", "cryptography", "hardware-support"]
keywords = ["ecdsa", "rsa", "piv", "pcsc", "yubikey"]
edition = "2021"
rust-version = "1.56"
rust-version = "1.81"

[dependencies]
clap = { version = "4", features = ["derive"] }
Expand Down
2 changes: 1 addition & 1 deletion cli/src/terminal.rs
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ pub fn print_cert_info(
print_cert_attr(
stream,
"Fingerprint",
&hex::upper::encode_string(&fingerprint),
hex::upper::encode_string(&fingerprint),
)?;
print_cert_attr(
stream,
Expand Down
4 changes: 2 additions & 2 deletions src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -192,8 +192,8 @@ impl std::error::Error for Error {
}
}

impl From<x509_cert::der::Error> for Error {
fn from(_err: x509_cert::der::Error) -> Error {
impl From<der::Error> for Error {
fn from(_err: der::Error) -> Error {
Error::ParseError
}
}
32 changes: 12 additions & 20 deletions src/mgm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -155,15 +155,12 @@ impl MgmKey {
pub fn get_protected(yubikey: &mut YubiKey) -> Result<Self> {
let txn = yubikey.begin_transaction()?;

let protected_data = ProtectedData::read(&txn).map_err(|e| {
error!("could not read protected data (err: {:?})", e);
e
})?;
let protected_data = ProtectedData::read(&txn)
.inspect_err(|e| error!("could not read protected data (err: {:?})", e))?;

let item = protected_data.get_item(TAG_PROTECTED_MGM).map_err(|e| {
error!("could not read protected MGM from metadata (err: {:?})", e);
e
})?;
let item = protected_data
.get_item(TAG_PROTECTED_MGM)
.inspect_err(|e| error!("could not read protected MGM from metadata (err: {:?})", e))?;

if item.len() != DES_LEN_3DES {
error!(
Expand Down Expand Up @@ -196,12 +193,10 @@ impl MgmKey {
pub fn set_manual(&self, yubikey: &mut YubiKey, require_touch: bool) -> Result<()> {
let txn = yubikey.begin_transaction()?;

txn.set_mgm_key(self, require_touch).map_err(|e| {
txn.set_mgm_key(self, require_touch)
// Log a warning, since the device mgm key is corrupt or we're in a state
// where we can't set the mgm key.
error!("could not set new derived mgm key, err = {}", e);
e
})?;
.inspect_err(|e| error!("could not set new derived mgm key, err = {}", e))?;

// After this point, we've set the mgm key, so the function should succeed,
// regardless of being able to set the metadata.
Expand Down Expand Up @@ -255,12 +250,10 @@ impl MgmKey {
pub fn set_protected(&self, yubikey: &mut YubiKey) -> Result<()> {
let txn = yubikey.begin_transaction()?;

txn.set_mgm_key(self, false).map_err(|e| {
txn.set_mgm_key(self, false)
// log a warning, since the device mgm key is corrupt or we're in
// a state where we can't set the mgm key
error!("could not set new derived mgm key, err = {}", e);
e
})?;
.inspect_err(|e| error!("could not set new derived mgm key, err = {}", e))?;

// after this point, we've set the mgm key, so the function should
// succeed, regardless of being able to set the metadata
Expand All @@ -272,10 +265,9 @@ impl MgmKey {
if let Err(e) = protected_data.set_item(TAG_PROTECTED_MGM, self.as_ref()) {
error!("could not set protected mgm item, err = {:?}", e);
} else {
protected_data.write(&txn).map_err(|e| {
error!("could not write protected data, err = {:?}", e);
e
})?;
protected_data
.write(&txn)
.inspect_err(|e| error!("could not write protected data, err = {:?}", e))?;
}

// set the protected mgm flag in admin data
Expand Down
7 changes: 3 additions & 4 deletions src/msroots.rs
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,9 @@ impl MsRoots {
}
}

MsRoots::new(&data).map(Some).map_err(|e| {
error!("error parsing msroots: {:?}", e);
e
})
MsRoots::new(&data)
.map(Some)
.inspect_err(|e| error!("error parsing msroots: {:?}", e))
}

/// Write `msroots` file to YubiKey
Expand Down
10 changes: 2 additions & 8 deletions src/transaction.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,7 @@ impl<'tx> Transaction<'tx> {
.p1(0x04)
.data(piv::APPLET_ID)
.transmit(self, 0xFF)
.map_err(|e| {
error!("failed communicating with card: '{}'", e);
e
})?;
.inspect_err(|e| error!("failed communicating with card: '{}'", e))?;

if !response.is_success() {
error!(
Expand Down Expand Up @@ -335,10 +332,7 @@ impl<'tx> Transaction<'tx> {

let response = self
.transfer_data(&templ, &indata[..offset], 1024)
.map_err(|e| {
error!("sign command failed to communicate: {}", e);
e
})?;
.inspect_err(|e| error!("sign command failed to communicate: {}", e))?;

if !response.is_success() {
error!("failed sign command with code {:x}", response.code());
Expand Down
30 changes: 13 additions & 17 deletions src/yubikey.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ use crate::{
transaction::Transaction,
};
use log::{error, info};
use pcsc::{Card, Disposition};
use pcsc::Card;
use rand_core::{OsRng, RngCore};
use std::{
fmt::{self, Display},
Expand Down Expand Up @@ -293,7 +293,10 @@ impl YubiKey {
/// `YubiKey` implements `Drop` which automatically disconnects the card using
/// `Disposition::ResetCard`; you only need to call this function if you want to
/// handle errors or use a different disposition method.
pub fn disconnect(self, disposition: Disposition) -> core::result::Result<(), (Self, Error)> {
pub fn disconnect(
self,
disposition: pcsc::Disposition,
) -> core::result::Result<(), (Self, Error)> {
let Self {
card,
name,
Expand Down Expand Up @@ -523,15 +526,11 @@ impl YubiKey {

admin_data
.set_item(TAG_ADMIN_TIMESTAMP, &tnow)
.map_err(|e| {
error!("could not set pin timestamp, err = {}", e);
e
})?;
.inspect_err(|e| error!("could not set pin timestamp, err = {}", e))?;

admin_data.write(&txn).map_err(|e| {
error!("could not write admin data, err = {}", e);
e
})?;
admin_data
.write(&txn)
.inspect_err(|e| error!("could not write admin data, err = {}", e))?;

Ok(())
}
Expand Down Expand Up @@ -581,7 +580,7 @@ impl YubiKey {

// Attempt to set the "PUK blocked" flag in admin data.
let mut admin_data = AdminData::read(&txn)
.map(|data| {
.inspect(|data| {
if let Ok(item) = data.get_item(TAG_ADMIN_FLAGS_1) {
if item.len() == flags.len() {
flags.copy_from_slice(item)
Expand All @@ -593,8 +592,6 @@ impl YubiKey {
);
}
}

data
})
.unwrap_or_default();

Expand Down Expand Up @@ -703,10 +700,9 @@ impl<'a> TryFrom<&'a Reader<'_>> for YubiKey {
type Error = Error;

fn try_from(reader: &'a Reader<'_>) -> Result<Self> {
let mut card = reader.connect().map_err(|e| {
error!("error connecting to reader '{}': {}", reader.name(), e);
e
})?;
let mut card = reader
.connect()
.inspect_err(|e| error!("error connecting to reader '{}': {}", reader.name(), e))?;

info!("connected to reader: {}", reader.name());

Expand Down
7 changes: 2 additions & 5 deletions tests/integration.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ use signature::hazmat::PrehashVerifier;
use std::{env, str::FromStr, sync::Mutex, time::Duration};
use x509_cert::{der::Encode, name::Name, serial_number::SerialNumber, time::Validity};
use yubikey::{
certificate,
certificate::yubikey_signer,
certificate::Certificate,
certificate::{yubikey_signer, Certificate},
piv::{self, AlgorithmId, Key, ManagementSlotId, RetiredSlotId, SlotId},
Error, MgmKey, PinPolicy, Serial, TouchPolicy, YubiKey,
};
Expand Down Expand Up @@ -317,8 +315,7 @@ fn test_read_metadata() {
#[ignore]
fn test_parse_cert_from_der() {
let bob_der = std::fs::read("tests/assets/Bob.der").expect(".der file not found");
let cert =
certificate::Certificate::from_bytes(bob_der).expect("Failed to parse valid certificate");
let cert = Certificate::from_bytes(bob_der).expect("Failed to parse valid certificate");
assert_eq!(
cert.subject(),
"CN=Bob",
Expand Down

0 comments on commit 32cd92a

Please sign in to comment.