libpass 0.4.0

library for interacting with pass managed data
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
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

#![allow(clippy::unwrap_used)]

use crate::utils;
use crate::*;
use std::io::Read;

fn set_store_dir() {
    env::set_var(
        PASSWORD_STORE_DIR_ENV,
        env::current_dir().unwrap().join("tests/simple"),
    );
}

fn retrieve_file(pass_name: &str) -> StoreFileRef {
    match retrieve(pass_name).unwrap() {
        StoreEntry::File(file) => file,
        StoreEntry::Directory(_) => panic!("not a file"),
    }
}

#[test]
fn test_get_store_dir() {
    env::remove_var(PASSWORD_STORE_DIR_ENV);
    assert_eq!(
        password_store_dir().unwrap(),
        utils::canonicalize_path(&PathBuf::from("~/.password-store")).unwrap()
    );

    set_store_dir();
    assert_eq!(
        password_store_dir().unwrap(),
        env::current_dir().unwrap().join("tests/simple")
    );
}

#[test]
fn test_list_entries() {
    set_store_dir();
    assert_eq!(
        dbg!(list()).unwrap(),
        HashSet::from_iter(vec![
            StoreEntry::File(StoreFileRef {
                path: password_store_dir().unwrap().join("secret-a.gpg")
            }),
            StoreEntry::File(StoreFileRef {
                path: password_store_dir().unwrap().join("secret-b.gpg")
            }),
            StoreEntry::File(StoreFileRef {
                path: password_store_dir().unwrap().join("folder/subsecret-a.gpg")
            }),
            StoreEntry::File(StoreFileRef {
                path: password_store_dir().unwrap().join("folder/subsecret-b.gpg")
            }),
            StoreEntry::File(StoreFileRef {
                path: password_store_dir()
                    .unwrap()
                    .join("folder/subfolder/generated-a.gpg"),
            }),
            StoreEntry::File(StoreFileRef {
                path: password_store_dir()
                    .unwrap()
                    .join("folder/subfolder/generated-b.gpg"),
            }),
            StoreEntry::File(StoreFileRef {
                path: password_store_dir()
                    .unwrap()
                    .join("folder2/subsecret-a.gpg")
            })
        ])
    );
}

#[test]
fn test_retrieve_entry() {
    set_store_dir();

    // retrieving the store root works
    assert!(retrieve("/").is_ok());
    assert!(retrieve("/").is_ok());

    // retrieving a secret works
    assert_eq!(
        retrieve("secret-a").unwrap(),
        StoreEntry::File(StoreFileRef {
            path: password_store_dir().unwrap().join("secret-a.gpg")
        })
    );

    // retrieving a secret in subfolders works
    assert_eq!(
        retrieve("folder/subfolder/generated-a").unwrap(),
        StoreEntry::File(StoreFileRef {
            path: password_store_dir()
                .unwrap()
                .join("folder/subfolder/generated-a.gpg")
        })
    );

    // retrieving a folder works
    assert!(retrieve("folder").is_ok());
    assert!(retrieve("folder/").is_ok());

    // retrieving not existing things returns an error but does not panic
    assert!(retrieve("not-existing-folder").is_err());
    assert!(retrieve("not-existing-folder/not-existing-secret").is_err());
}

#[test]
fn test_read_ciphertext() {
    set_store_dir();
    let entry = retrieve_file("secret-a");

    let mut buffer = Vec::new();
    assert!(entry
        .cipher_io()
        .unwrap()
        .as_mut()
        .read_to_end(&mut buffer)
        .is_ok());
}

#[test]
fn test_write_plaintext() {
    set_store_dir();
    let mut handle = retrieve_file("secret-a").plain_io_rw().unwrap();
    let original_content = handle.as_ref().to_vec();

    // write something different into the file
    *handle.as_mut() = "hello world".as_bytes().to_vec();
    assert!(dbg!(handle.sync(false)).is_ok());

    // restore file content
    *handle.as_mut() = original_content;
    assert!(dbg!(handle.sync(false)).is_ok())
}

#[test]
fn test_read_plaintext() {
    set_store_dir();
    let entry = retrieve_file("secret-a");

    assert_eq!(
        entry.plain_io_rw().unwrap().as_ref(),
        "foobar123\n".as_bytes()
    );
}

#[test]
fn test_get_entry_name() {
    set_store_dir();

    // simple file
    assert_eq!(retrieve("secret-a").unwrap().name().unwrap(), "secret-a");

    // simple directory
    assert_eq!(retrieve("folder").unwrap().name().unwrap(), "folder");

    // file in subdirectory
    assert_eq!(
        retrieve("folder/subsecret-a").unwrap().name().unwrap(),
        "folder/subsecret-a"
    );

    // directory in subdirectory
    assert_eq!(
        retrieve("folder/subfolder").unwrap().name().unwrap(),
        "folder/subfolder"
    );
}

#[test]
fn test_get_encryption_keys() {
    set_store_dir();

    // file at store root
    assert_eq!(
        retrieve_file("secret-a").encryption_keys().unwrap()[0]
            .id()
            .unwrap(),
        "8497251104B6F45F"
    );

    // file in subfolder
    assert_eq!(
        retrieve_file("folder/subfolder/generated-a")
            .encryption_keys()
            .unwrap()[0]
            .id()
            .unwrap(),
        "8497251104B6F45F"
    );
}