mirror of
https://github.com/laurent22/joplin.git
synced 2024-12-12 08:54:00 +02:00
81 lines
2.9 KiB
TypeScript
81 lines
2.9 KiB
TypeScript
import KeychainServiceDriverBase from './KeychainServiceDriverBase';
|
|
import Setting from '../../models/Setting';
|
|
import BaseService from '../BaseService';
|
|
|
|
export default class KeychainService extends BaseService {
|
|
|
|
private driver: KeychainServiceDriverBase;
|
|
private static instance_: KeychainService;
|
|
private enabled_ = true;
|
|
|
|
public static instance(): KeychainService {
|
|
if (!this.instance_) this.instance_ = new KeychainService();
|
|
return this.instance_;
|
|
}
|
|
|
|
public initialize(driver: KeychainServiceDriverBase) {
|
|
if (!driver.appId || !driver.clientId) throw new Error('appId and clientId must be set on the KeychainServiceDriver');
|
|
this.driver = driver;
|
|
}
|
|
|
|
// This is to programatically disable the keychain service, whether keychain
|
|
// is supported or not in the system (In other word, this be might "enabled"
|
|
// but nothing will be saved to the keychain if there isn't one).
|
|
public get enabled(): boolean {
|
|
if (!this.enabled_) return false;
|
|
|
|
// Otherwise we assume it's enabled if "keychain.supported" is either -1
|
|
// (undetermined) or 1 (working). We make it work for -1 too because the
|
|
// setPassword() and password() functions need to work to test if the
|
|
// keychain is supported (in detectIfKeychainSupported).
|
|
return Setting.value('keychain.supported') !== 0;
|
|
}
|
|
|
|
public set enabled(v: boolean) {
|
|
this.enabled_ = v;
|
|
}
|
|
|
|
public async setPassword(name: string, password: string): Promise<boolean> {
|
|
if (!this.enabled) return false;
|
|
|
|
// Due to a bug in macOS, this may throw an exception "The user name or passphrase you entered is not correct."
|
|
// The fix is to open Keychain Access.app. Right-click on the login keychain and try locking it and then unlocking it again.
|
|
// https://github.com/atom/node-keytar/issues/76
|
|
return this.driver.setPassword(name, password);
|
|
}
|
|
|
|
public async password(name: string): Promise<string> {
|
|
if (!this.enabled) return null;
|
|
|
|
return this.driver.password(name);
|
|
}
|
|
|
|
public async deletePassword(name: string): Promise<void> {
|
|
if (!this.enabled) return;
|
|
|
|
await this.driver.deletePassword(name);
|
|
}
|
|
|
|
public async detectIfKeychainSupported() {
|
|
this.logger().info('KeychainService: checking if keychain supported');
|
|
|
|
if (Setting.value('keychain.supported') >= 0) {
|
|
this.logger().info('KeychainService: check was already done - skipping. Supported:', Setting.value('keychain.supported'));
|
|
return;
|
|
}
|
|
|
|
const passwordIsSet = await this.setPassword('zz_testingkeychain', 'mytest');
|
|
|
|
if (!passwordIsSet) {
|
|
this.logger().info('KeychainService: could not set test password - keychain support will be disabled');
|
|
Setting.setValue('keychain.supported', 0);
|
|
} else {
|
|
const result = await this.password('zz_testingkeychain');
|
|
await this.deletePassword('zz_testingkeychain');
|
|
this.logger().info('KeychainService: tried to set and get password. Result was:', result);
|
|
Setting.setValue('keychain.supported', result === 'mytest' ? 1 : 0);
|
|
}
|
|
}
|
|
|
|
}
|