Code Monkey home page Code Monkey logo

secret-service-rs's Introduction

Secret Service

Secret Service Rust library.

Interfaces with the Linux Secret Service API through dbus.

This library is feature complete, has stabilized its API, and has removed extraneous dependencies, so I've made it 1.0.

Documentation

Get Docs!

Basic Usage

Does not require dbus library! Pure Rust! (On ubuntu, this was libdbus-1-dev when building, and libdbus-1-3 when running)

In Cargo.toml:

[dependencies]
secret-service = "2.0.0"

If you have cargo-extras installed, can replace above step with the command at the prompt in your project directory:

$ cargo add secret-service

In source code (below example is for --bin, not --lib)

extern crate secret_service;
use secret_service::SecretService;
use secret_service::EncryptionType;
use std::error::Error;

fn main() -> Result<(), Box<Error>> {

    // initialize secret service (dbus connection and encryption session)
    let ss = SecretService::new(EncryptionType::Dh)?;

    // get default collection
    let collection = ss.get_default_collection()?;

    //create new item
    collection.create_item(
        "test_label", // label
        vec![("test", "test_value")], // properties
        b"test_secret", //secret
        false, // replace item with same attributes
        "text/plain" // secret content type
    )?;

    // search items by properties
    let search_items = ss.search_items(
        vec![("test", "test_value")]
    )?;

    let item = search_items.get(0)?;

    // retrieve secret from item
    let secret = item.get_secret()?;
    assert_eq!(secret, b"test_secret");

    // delete item (deletes the dbus object, not the struct instance)
    item.delete()?;
}

Functionality

  • SecretService: initialize dbus, create plain/encrypted session.
  • Collections: create, delete, search.
  • Items: create, delete, search, get/set secret.

Changelog

0.1.0

  • dependency on gmp is removed.
  • rust-crypto replaced by RustCrypto.
  • as a result of above, error on encrypting and decrypting blank input is fixed.

...

0.4.0

  • gmp is now optional dependency.
  • gmp upgraded to 0.3 to fix "private-in-public" warnings which will be hard errors soon.

1.0.0

  • switch from rust-crypto to RustCrypto
  • remove gmp dep for powm
  • update rand and num

1.1.0

  • Fix, get_collection_* returns Error::NoResult when doesn't exist
  • udpate hkdf to 0.8

1.1.1

  • update deps

1.1.2

  • update rand

1.1.3

  • update deps

2.0.0

  • dbus replaced by zbus, PURE RUST!
  • update to 2018 edition
  • BREAKING: SsError renamed to Error
  • BREAKING: variants added to Error
  • BREAKING: attributes are now HashMap<&str, &str> or HashMap<String, String> instead of Vec<(&str, &str)>. Not sure why I decided this way back when, but it could cause unexpected behavior for user: when the Vec was transformed to HashMap internally, tuples could be lost if the keys were the same.
  • BREAKING: Collection::new and Item::new are now private (although I don't think it was possible to use them anyways)

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

secret-service-rs's People

Contributors

cogitri avatar complexspaces avatar cuviper avatar decathorpe avatar hwchen avatar petrochenkov avatar repi avatar steveatinfincia avatar wgh- avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.