keyring-manager 0.8.1

Cross-platform library for managing passwords
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
use crate::error::{KeyringError, Result};
use crate::*;
use jni::errors::Error;
use jni::errors::Result as JniResult;
use jni::objects::{Global, JClass, JObject, JString, JValue, JValueOwned};
use jni::{jni_sig, jni_str, Env, JavaVM};

///////////////////////////////////////////////////////////

macro_rules! check_exception {
    ($env:expr, $err:expr, $message:expr) => {
        if $env.exception_check() {
            let _ = $env.exception_clear();
            $err = Some(KeyringError::AndroidKeystoreError($message.to_owned()));
            return Err(Error::JavaException);
        }
    };
}

///////////////////////////////////////////////////////////

pub type AndroidKeyringContext = (JavaVM, Global<JObject<'static>>);

pub struct AndroidKeyringManager {
    vm: JavaVM,
    encrypted_shared_preferences: Global<JObject<'static>>,
    _class_loader: Global<JObject<'static>>,
}

impl Drop for AndroidKeyringManager {
    fn drop(&mut self) {
        // Ensure we're attached before dropping GlobalRef
        self.vm
            .attach_current_thread(|_| JniResult::Ok(()))
            .unwrap();
    }
}

impl AndroidKeyringManager {
    pub fn new(application: &str, ctx: AndroidKeyringContext) -> Result<AndroidKeyringManager> {
        let vm = ctx.0;
        let context = ctx.1.as_obj();
        let application = application.to_owned();

        let (encrypted_shared_preferences, class_loader) = vm
            .attach_current_thread(|env| {
                env.with_local_frame(256, |jnienv| {
                    let class_loader = get_class_loader(jnienv, context)?;
                    let master_key = get_master_key(jnienv, context, &class_loader)?;

                    let encrypted_shared_preferences = get_encrypted_shared_preferences(
                        jnienv,
                        application,
                        context,
                        &class_loader,
                        &master_key,
                    )?;

                    JniResult::Ok((
                        jnienv.new_global_ref(encrypted_shared_preferences)?,
                        jnienv.new_global_ref(class_loader)?,
                    ))
                })
            })
            .map_err(|e| KeyringError::Generic(format!("{}", e)))?;

        Ok(AndroidKeyringManager {
            vm,
            encrypted_shared_preferences,
            _class_loader: class_loader,
        })
    }

    pub fn with_keyring<F, T>(&self, service: &str, key: &str, func: F) -> Result<T>
    where
        F: FnOnce(&mut dyn Keyring) -> Result<T>,
    {
        self.vm
            .attach_current_thread(|env| {
                let mut kr = AndroidKeyring::new(self, env, service, key);
                JniResult::Ok(func(&mut kr))
            })
            .map_err(|e| KeyringError::Generic(format!("{}", e)))?
    }
}

pub struct AndroidKeyring<'a, 'b> {
    manager: &'a AndroidKeyringManager,
    jnienv: &'a mut Env<'b>,
    service: &'a str,
    key: &'a str,
}

impl<'a, 'b> AndroidKeyring<'a, 'b> {
    fn new(
        manager: &'a AndroidKeyringManager,
        jnienv: &'a mut Env<'b>,
        service: &'a str,
        key: &'a str,
    ) -> AndroidKeyring<'a, 'b> {
        AndroidKeyring {
            manager,
            jnienv,
            service,
            key,
        }
    }

    fn make_key_string(&self) -> String {
        format!(
            "{}\t{}",
            crate::escape(self.service),
            crate::escape(self.key)
        )
    }
}

impl<'a, 'b> Keyring for AndroidKeyring<'a, 'b> {
    fn set_value(&mut self, value: &str) -> Result<()> {
        let mut err: Option<KeyringError> = None;
        let key_string = self.make_key_string();
        let encrypted_shared_preferences = self.manager.encrypted_shared_preferences.as_obj();
        let out = self.jnienv.with_local_frame(256, |jnienv| {
            let editor = jnienv
                .call_method(
                    encrypted_shared_preferences,
                    jni_str!("edit"),
                    jni_sig!("()Landroid/content/SharedPreferences$Editor;"),
                    &[],
                )?
                .l()?;
            check_exception!(jnienv, err, "Couldn't edit shared preferences");

            let k = get_string_jvalue(jnienv, &key_string)?;
            let v = get_string_jvalue(jnienv, &crate::escape(value))?;
            let editor = jnienv
                .call_method(
                    editor,
                    jni_str!("putString"),
                    jni_sig!("(Ljava/lang/String;Ljava/lang/String;)Landroid/content/SharedPreferences$Editor;"),
                    &[ k.borrow(), v.borrow() ],
                )
                ?
                .l()
                ?;
            check_exception!(jnienv, err, "Couldn't put string to shared preferences");

            let _ = jnienv.call_method(editor, jni_str!("apply"), jni_sig!("()V"), &[])?;
            check_exception!(jnienv, err, "Couldn't put apply changes to shared preferences");
            Ok(())
        });

        if let Some(err) = err {
            return Err(err);
        }

        out.map_err(|e| KeyringError::AndroidKeystoreError(format!("{}", e)))
    }

    fn get_value(&self) -> Result<String> {
        let mut err: Option<KeyringError> = None;
        let key_string = self.make_key_string();
        let encrypted_shared_preferences = self.manager.encrypted_shared_preferences.as_obj();
        let out = self.jnienv.with_local_frame(256, |jnienv| {
            let k = get_string_jvalue(jnienv, &key_string)?;
            let exists = jnienv
                .call_method(
                    self.manager.encrypted_shared_preferences.as_obj(),
                    jni_str!("contains"),
                    jni_sig!("(Ljava/lang/String;)Z"),
                    &[k.borrow()],
                )?
                .z()?;
            check_exception!(
                jnienv,
                err,
                "Couldn't check existence of string from shared preferences"
            );

            if !exists {
                err = Some(KeyringError::NoPasswordFound);
                return Ok(String::new());
            }

            let value = jnienv
                .call_method(
                    encrypted_shared_preferences,
                    jni_str!("getString"),
                    jni_sig!("(Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String;"),
                    &[k.borrow(), JValue::Object(&JObject::null())],
                )?
                .l()?;
            check_exception!(jnienv, err, "Couldn't get string from shared preferences");

            let jstr = JString::cast_local(jnienv, value)?;
            Ok(jstr.to_string())
        });

        if let Some(err) = err {
            return Err(err);
        }

        let out = out.map_err(|e| KeyringError::AndroidKeystoreError(format!("{}", e)))?;
        let out = crate::unescape(&out).map_err(map_to_generic)?;

        Ok(out)
    }

    fn delete_value(&mut self) -> Result<()> {
        let mut err: Option<KeyringError> = None;
        let key_string = self.make_key_string();
        let encrypted_shared_preferences = self.manager.encrypted_shared_preferences.as_obj();
        let out = self.jnienv.with_local_frame(256, |jnienv| {
            let k = get_string_jvalue(jnienv, &key_string)?;
            let exists = jnienv
                .call_method(
                    encrypted_shared_preferences,
                    jni_str!("contains"),
                    jni_sig!("(Ljava/lang/String;)Z"),
                    &[k.borrow()],
                )?
                .z()?;
            check_exception!(
                jnienv,
                err,
                "Couldn't check existence of string from shared preferences"
            );

            if !exists {
                err = Some(KeyringError::NoPasswordFound);
                return Ok(());
            }

            let editor = jnienv
                .call_method(
                    encrypted_shared_preferences,
                    jni_str!("edit"),
                    jni_sig!("()Landroid/content/SharedPreferences$Editor;"),
                    &[],
                )?
                .l()?;
            check_exception!(jnienv, err, "Couldn't edit shared preferences");

            let editor = jnienv
                .call_method(
                    editor,
                    jni_str!("remove"),
                    jni_sig!("(Ljava/lang/String;)Landroid/content/SharedPreferences$Editor;"),
                    &[k.borrow()],
                )?
                .l()?;
            check_exception!(
                jnienv,
                err,
                "Couldn't remove string from shared preferences"
            );

            let _ = jnienv.call_method(editor, jni_str!("apply"), jni_sig!("()V"), &[])?;
            check_exception!(
                jnienv,
                err,
                "Couldn't put apply changes to shared preferences"
            );

            Ok(())
        });

        if let Some(err) = err {
            return Err(err);
        }

        out.map_err(|e| KeyringError::AndroidKeystoreError(format!("{}", e)))
    }
}

///////////////////////////////////////////////////////////

pub fn get_string_jvalue<'a>(jnienv: &mut Env<'a>, s: &str) -> JniResult<JValueOwned<'a>> {
    Ok(JValueOwned::from(JObject::from(jnienv.new_string(s)?)))
}

pub fn get_class_loader<'a>(jnienv: &mut Env<'a>, context: &JObject<'a>) -> JniResult<JObject<'a>> {
    jnienv
        .call_method(
            context,
            jni_str!("getClassLoader"),
            jni_sig!("()Ljava/lang/ClassLoader;"),
            &[],
        )?
        .l()
}

pub fn load_class<'a, 'b>(
    jnienv: &mut Env<'a>,
    class_loader: &JObject<'b>,
    name: &str,
) -> JniResult<JClass<'a>> {
    let name = get_string_jvalue(jnienv, name)?;
    let class = jnienv
        .call_method(
            class_loader,
            jni_str!("loadClass"),
            jni_sig!("(Ljava/lang/String;)Ljava/lang/Class;"),
            &[name.borrow()],
        )?
        .l()?;

    JClass::cast_local(jnienv, class)
}

pub fn get_master_key<'b>(
    jnienv: &mut Env<'b>,
    context: &JObject<'b>,
    class_loader: &JObject<'b>,
) -> JniResult<JObject<'b>> {
    // KeyGenParameterSpec spec = new KeyGenParameterSpec.Builder(
    //     MASTER_KEY_ALIAS,
    //     KeyProperties.PURPOSE_ENCRYPT | KeyProperties.PURPOSE_DECRYPT)
    //     .setBlockModes(KeyProperties.BLOCK_MODE_GCM)
    //     .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE)
    //     .setKeySize(KEY_SIZE)
    //     .build();
    jnienv.with_local_frame_returning_local::<_, JObject, _>(64, |jnienv| {
        let c_kgps_builder = load_class(jnienv, class_loader, "android/security/keystore/KeyGenParameterSpec$Builder")?;
        let c_master_key = load_class(jnienv, class_loader, "androidx/security/crypto/MasterKey")?;
        let c_key_properties = load_class(jnienv, class_loader,"android/security/keystore/KeyProperties")?;
        let c_string = load_class(jnienv, class_loader, "java/lang/String")?;
        let c_master_key_builder = load_class(jnienv, class_loader, "androidx/security/crypto/MasterKey$Builder")?;

        let sf_dmka = jnienv.get_static_field(
            &c_master_key,
            jni_str!("DEFAULT_MASTER_KEY_ALIAS"),
            jni_sig!("Ljava/lang/String;"),
        )?;
        let sf_pe =jnienv.get_static_field(
            &c_key_properties,
            jni_str!("PURPOSE_ENCRYPT"),
            jni_sig!("I"),
        )?;
        let sf_pd = jnienv
        .get_static_field(
            &c_key_properties,
            jni_str!("PURPOSE_DECRYPT"),
            jni_sig!("I"),
        )?;
        let builder = jnienv
            .new_object(
                c_kgps_builder,
                jni_sig!("(Ljava/lang/String;I)V"),
                &[
                    sf_dmka.borrow(),
                    JValue::Int(sf_pe.i()? | sf_pd.i()?),
                ],
            )
            ?;
        let sf_bm_gcm = jnienv.get_static_field(
            &c_key_properties,
            jni_str!("BLOCK_MODE_GCM"),
            jni_sig!("Ljava/lang/String;"),
        )?.l()?;
        let sbm_params = jnienv.new_object_array(
            1,
            &c_string,
            sf_bm_gcm,
        )?;
        let builder = jnienv
            .call_method(
                builder,
                jni_str!("setBlockModes"),
                jni_sig!("([Ljava/lang/String;)Landroid/security/keystore/KeyGenParameterSpec$Builder;"),
                &[JValue::from(&*sbm_params)],
            )?.l()?;

        let sf_epn = jnienv.get_static_field(
                &c_key_properties,
                jni_str!("ENCRYPTION_PADDING_NONE"),
                jni_sig!("Ljava/lang/String;"),
            )?;
        let sep_params = jnienv.new_object_array(
                1,
                &c_string,
                sf_epn.l()?,
            )?;
        let builder = jnienv
            .call_method(
                builder,
                jni_str!("setEncryptionPaddings"),
                jni_sig!("([Ljava/lang/String;)Landroid/security/keystore/KeyGenParameterSpec$Builder;"),
                &[JValue::from(&*sep_params)],
            )?.l()?;
        let sf_dagmks = jnienv
            .get_static_field(
                &c_master_key,
                jni_str!("DEFAULT_AES_GCM_MASTER_KEY_SIZE"),
                jni_sig!("I"),
            )?;
        let builder = jnienv
            .call_method(
                builder,
                jni_str!("setKeySize"),
                jni_sig!("(I)Landroid/security/keystore/KeyGenParameterSpec$Builder;"),
                &[sf_dagmks.borrow()],
            )?.l()?;
        let spec = jnienv
            .call_method(
                builder,
                jni_str!("build"),
                jni_sig!("()Landroid/security/keystore/KeyGenParameterSpec;"),
                &[],
            )?;
        // return new MasterKey.Builder(MainActivity.this)
        //      .setKeyGenParameterSpec(spec)
        //      .build();
        let mkbuilder = jnienv
            .new_object(
                &c_master_key_builder,
                jni_sig!("(Landroid/content/Context;)V"),
                &[JValue::from(context)],
            )?;
        let mkbuilder = jnienv.call_method(mkbuilder,
            jni_str!("setKeyGenParameterSpec"), 
            jni_sig!("(Landroid/security/keystore/KeyGenParameterSpec;)Landroidx/security/crypto/MasterKey$Builder;"), 
            &[ spec.borrow() ])?.l()?;
        let master_key = jnienv
            .call_method(
                mkbuilder,
                jni_str!("build"),
                jni_sig!("()Landroidx/security/crypto/MasterKey;"),
                &[],
            )?.l()?;
        Ok(master_key)
    })
}

pub fn get_encrypted_shared_preferences<'b>(
    jnienv: &mut Env<'b>,
    application: String,
    context: &JObject<'b>,
    class_loader: &JObject<'b>,
    master_key: &JObject<'b>,
) -> JniResult<JObject<'b>> {
    jnienv.with_local_frame_returning_local::<_, JObject, _>(64, |jnienv| {
        let c_esp = load_class(jnienv, class_loader, "androidx/security/crypto/EncryptedSharedPreferences")?;
        let c_esp_pkes = load_class(
            jnienv,
            class_loader,
            "androidx/security/crypto/EncryptedSharedPreferences$PrefKeyEncryptionScheme")?;
        let c_esp_pves =load_class(
            jnienv,
            class_loader,
            "androidx/security/crypto/EncryptedSharedPreferences$PrefValueEncryptionScheme")?;    
        let application = get_string_jvalue(jnienv, &application)?;
        let sf_pkes = jnienv.get_static_field(
            c_esp_pkes,
            jni_str!("AES256_SIV"), 
            jni_sig!("Landroidx/security/crypto/EncryptedSharedPreferences$PrefKeyEncryptionScheme;"))?;
        let sf_pves = jnienv.get_static_field(
            c_esp_pves,
            jni_str!("AES256_GCM"), 
            jni_sig!("Landroidx/security/crypto/EncryptedSharedPreferences$PrefValueEncryptionScheme;"))?;
        let esp = jnienv.call_static_method(
            &c_esp,
            jni_str!("create"), 
            jni_sig!("(Landroid/content/Context;Ljava/lang/String;Landroidx/security/crypto/MasterKey;Landroidx/security/crypto/EncryptedSharedPreferences$PrefKeyEncryptionScheme;Landroidx/security/crypto/EncryptedSharedPreferences$PrefValueEncryptionScheme;)Landroid/content/SharedPreferences;"),
            &[
                JValue::from(context),
                application.borrow(),
                JValue::Object(master_key),
                sf_pkes.borrow(),
                sf_pves.borrow()
            ])?.l()?;
        Ok(esp)
    })
}