turnkey/openpgp-card
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

openpgp-card-sequoia: update doc comments

Browse source
This commit is contained in:
Heiko Schaefer 2022-10-25 01:02:56 +02:00
parent fe61a398a9
commit 37a99b63cf
No known key found for this signature in database
GPG key ID: 4A849A1904CCBD7D
1 changed files with 20 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
openpgp-card-sequoia/src/lib.rs
View file

@ -13,13 +13,12 @@
//! //!
//! ```no_run //! ```no_run
//! use openpgp_card_pcsc::PcscBackend; //! use openpgp_card_pcsc::PcscBackend;
//! use openpgp_card::OpenPgp; //! use openpgp_card_sequoia::card::Card;
//! use openpgp_card_sequoia::card::Open;
//! //!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> { //! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! for card in PcscBackend::cards(None)? { //! for backend in PcscBackend::cards(None)? {
//! let mut pgp = OpenPgp::new(card); //! let mut card = Card::new(backend);
//! let mut open = Open::new(pgp.transaction()?)?; //! let mut open = card.transaction()?;
//! println!("Found OpenPGP card with ident '{}'", //! println!("Found OpenPGP card with ident '{}'",
//! open.application_identifier()?.ident()); //! open.application_identifier()?.ident());
//! } //! }
@ -31,13 +30,12 @@
//! //!
//! ```no_run //! ```no_run
//! use openpgp_card_pcsc::PcscBackend; //! use openpgp_card_pcsc::PcscBackend;
//! use openpgp_card::OpenPgp; //! use openpgp_card_sequoia::card::Card;
//! use openpgp_card_sequoia::card::Open;
//! //!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> { //! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let card = PcscBackend::open_by_ident("abcd:12345678", None)?; //! let backend = PcscBackend::open_by_ident("abcd:12345678", None)?;
//! let mut pgp = OpenPgp::new(card); //! let mut card = Card::new(backend);
//! let mut open = Open::new(pgp.transaction()?)?; //! let mut open = card.transaction()?;
//! # Ok(()) //! # Ok(())
//! # } //! # }
//! ``` //! ```
@ -53,15 +51,14 @@
//! //!
//! ```no_run //! ```no_run
//! use openpgp_card_pcsc::PcscBackend; //! use openpgp_card_pcsc::PcscBackend;
//! use openpgp_card::OpenPgp; //! use openpgp_card_sequoia::card::Card;
//! use openpgp_card_sequoia::card::Open;
//! //!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> { //! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! // Open card via PCSC //! // Open card via PCSC
//! use sequoia_openpgp::policy::StandardPolicy; //! use sequoia_openpgp::policy::StandardPolicy;
//! let card = PcscBackend::open_by_ident("abcd:12345678", None)?; //! let backend = PcscBackend::open_by_ident("abcd:12345678", None)?;
//! let mut pgp = OpenPgp::new(card); //! let mut card = Card::new(backend);
//! let mut open = Open::new(pgp.transaction()?)?; //! let mut open = card.transaction()?;
//! //!
//! // Get authorization for user access to the card with password //! // Get authorization for user access to the card with password
//! open.verify_user(b"123456")?; //! open.verify_user(b"123456")?;
@ -91,15 +88,13 @@
//! //!
//! ```no_run //! ```no_run
//! use openpgp_card_pcsc::PcscBackend; //! use openpgp_card_pcsc::PcscBackend;
//! use openpgp_card::OpenPgp; //! use openpgp_card_sequoia::card::Card;
//! use openpgp_card_sequoia::card::Open;
//! //!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> { //! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! // Open card via PCSC //! // Open card via PCSC
//! use sequoia_openpgp::policy::StandardPolicy; //! let backend = PcscBackend::open_by_ident("abcd:12345678", None)?;
//! let card = PcscBackend::open_by_ident("abcd:12345678", None)?; //! let mut card = Card::new(backend);
//! let mut pgp = OpenPgp::new(card); //! let mut open = card.transaction()?;
//! let mut open = Open::new(pgp.transaction()?)?;
//! //!
//! // Get authorization for signing access to the card with password //! // Get authorization for signing access to the card with password
//! open.verify_user_for_signing(b"123456")?; //! open.verify_user_for_signing(b"123456")?;
@ -119,14 +114,13 @@
//! //!
//! ```no_run //! ```no_run
//! use openpgp_card_pcsc::PcscBackend; //! use openpgp_card_pcsc::PcscBackend;
//! use openpgp_card::OpenPgp; //! use openpgp_card_sequoia::card::Card;
//! use openpgp_card_sequoia::card::Open;
//! //!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> { //! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! // Open card via PCSC //! // Open card via PCSC
//! let card = PcscBackend::open_by_ident("abcd:12345678", None)?; //! let backend = PcscBackend::open_by_ident("abcd:12345678", None)?;
//! let mut pgp = OpenPgp::new(card); //! let mut card = Card::new(backend);
//! let mut open = Open::new(pgp.transaction()?)?; //! let mut open = card.transaction()?;
//! //!
//! // Get authorization for admin access to the card with password //! // Get authorization for admin access to the card with password
//! open.verify_admin(b"12345678")?; //! open.verify_admin(b"12345678")?;