@salesforce/core 3.31.4 → 3.31.7

package/lib/crypto/keyChain.d.ts

@@ -1,8 +1,8 @@
-import { KeyChain } from './keyChainImpl';
-/**
- * Gets the os level keychain impl.
- *
- * @param platform The os platform.
- * @ignore
- */
-export declare const retrieveKeychain: (platform: string) => Promise<KeyChain>;
+import { KeyChain } from './keyChainImpl';
+/**
+ * Gets the os level keychain impl.
+ *
+ * @param platform The os platform.
+ * @ignore
+ */
+export declare const retrieveKeychain: (platform: string) => Promise<KeyChain>;

package/lib/crypto/keyChain.js

@@ -1,62 +1,62 @@
-"use strict";
-/*
- * Copyright (c) 2020, salesforce.com, inc.
- * All rights reserved.
- * Licensed under the BSD 3-Clause license.
- * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.retrieveKeychain = void 0;
-const kit_1 = require("@salesforce/kit");
-const logger_1 = require("../logger");
-const messages_1 = require("../messages");
-const keyChainImpl_1 = require("./keyChainImpl");
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.load('@salesforce/core', 'encryption', ['unsupportedOperatingSystemError']);
-/**
- * Gets the os level keychain impl.
- *
- * @param platform The os platform.
- * @ignore
- */
-const retrieveKeychain = async (platform) => {
-    const logger = await logger_1.Logger.child('keyChain');
-    logger.debug(`platform: ${platform}`);
-    const useGenericUnixKeychainVar = kit_1.env.getBoolean('SFDX_USE_GENERIC_UNIX_KEYCHAIN');
-    const shouldUseGenericUnixKeychain = useGenericUnixKeychainVar && useGenericUnixKeychainVar;
-    if (platform.startsWith('win')) {
-        return keyChainImpl_1.keyChainImpl.generic_windows;
-    }
-    else if (platform.includes('darwin')) {
-        // OSX can use the generic keychain. This is useful when running under an
-        // automation user.
-        if (shouldUseGenericUnixKeychain) {
-            return keyChainImpl_1.keyChainImpl.generic_unix;
-        }
-        else {
-            return keyChainImpl_1.keyChainImpl.darwin;
-        }
-    }
-    else if (platform.includes('linux')) {
-        // Use the generic keychain if specified
-        if (shouldUseGenericUnixKeychain) {
-            return keyChainImpl_1.keyChainImpl.generic_unix;
-        }
-        else {
-            // otherwise try and use the builtin keychain
-            try {
-                await keyChainImpl_1.keyChainImpl.linux.validateProgram();
-                return keyChainImpl_1.keyChainImpl.linux;
-            }
-            catch (e) {
-                // If the builtin keychain is not available use generic
-                return keyChainImpl_1.keyChainImpl.generic_unix;
-            }
-        }
-    }
-    else {
-        throw messages.createError('unsupportedOperatingSystemError', [platform]);
-    }
-};
-exports.retrieveKeychain = retrieveKeychain;
+"use strict";
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retrieveKeychain = void 0;
+const kit_1 = require("@salesforce/kit");
+const logger_1 = require("../logger");
+const messages_1 = require("../messages");
+const keyChainImpl_1 = require("./keyChainImpl");
+messages_1.Messages.importMessagesDirectory(__dirname);
+const messages = messages_1.Messages.load('@salesforce/core', 'encryption', ['unsupportedOperatingSystemError']);
+/**
+ * Gets the os level keychain impl.
+ *
+ * @param platform The os platform.
+ * @ignore
+ */
+const retrieveKeychain = async (platform) => {
+    const logger = await logger_1.Logger.child('keyChain');
+    logger.debug(`platform: ${platform}`);
+    const useGenericUnixKeychainVar = kit_1.env.getBoolean('SFDX_USE_GENERIC_UNIX_KEYCHAIN');
+    const shouldUseGenericUnixKeychain = useGenericUnixKeychainVar && useGenericUnixKeychainVar;
+    if (platform.startsWith('win')) {
+        return keyChainImpl_1.keyChainImpl.generic_windows;
+    }
+    else if (platform.includes('darwin')) {
+        // OSX can use the generic keychain. This is useful when running under an
+        // automation user.
+        if (shouldUseGenericUnixKeychain) {
+            return keyChainImpl_1.keyChainImpl.generic_unix;
+        }
+        else {
+            return keyChainImpl_1.keyChainImpl.darwin;
+        }
+    }
+    else if (platform.includes('linux')) {
+        // Use the generic keychain if specified
+        if (shouldUseGenericUnixKeychain) {
+            return keyChainImpl_1.keyChainImpl.generic_unix;
+        }
+        else {
+            // otherwise try and use the builtin keychain
+            try {
+                await keyChainImpl_1.keyChainImpl.linux.validateProgram();
+                return keyChainImpl_1.keyChainImpl.linux;
+            }
+            catch (e) {
+                // If the builtin keychain is not available use generic
+                return keyChainImpl_1.keyChainImpl.generic_unix;
+            }
+        }
+    }
+    else {
+        throw messages.createError('unsupportedOperatingSystemError', [platform]);
+    }
+};
+exports.retrieveKeychain = retrieveKeychain;
 //# sourceMappingURL=keyChain.js.map

package/lib/crypto/keyChainImpl.d.ts

@@ -1,116 +1,116 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import * as childProcess from 'child_process';
-import * as nodeFs from 'fs';
-import { Nullable } from '@salesforce/ts-types';
-export declare type FsIfc = Pick<typeof nodeFs, 'statSync'>;
-/**
- * Basic keychain interface.
- */
-export interface PasswordStore {
-    /**
-     * Gets a password
-     *
-     * @param opts cli level password options.
-     * @param fn function callback for password.
-     * @param retryCount number of reties to get the password.
-     */
-    getPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, password?: string) => void, retryCount?: number): Promise<void>;
-    /**
-     * Sets a password.
-     *
-     * @param opts cli level password options.
-     * @param fn function callback for password.
-     */
-    setPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, contents?: SecretContents) => void): Promise<void>;
-}
-/**
- * @private
- */
-export declare class KeychainAccess implements PasswordStore {
-    private osImpl;
-    private fsIfc;
-    /**
-     * Abstract prototype for general cross platform keychain interaction.
-     *
-     * @param osImpl The platform impl for (linux, darwin, windows).
-     * @param fsIfc The file system interface.
-     */
-    constructor(osImpl: OsImpl, fsIfc: FsIfc);
-    /**
-     * Validates the os level program is executable.
-     */
-    validateProgram(): Promise<void>;
-    /**
-     * Returns a password using the native program for credential management.
-     *
-     * @param opts Options for the credential lookup.
-     * @param fn Callback function (err, password).
-     * @param retryCount Used internally to track the number of retries for getting a password out of the keychain.
-     */
-    getPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, password?: string) => void, retryCount?: number): Promise<void>;
-    /**
-     * Sets a password using the native program for credential management.
-     *
-     * @param opts Options for the credential lookup.
-     * @param fn Callback function (err, ConfigContents).
-     */
-    setPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, contents?: SecretContents) => void): Promise<void>;
-}
-interface ProgramOpts {
-    account: string;
-    service: string;
-    password?: string;
-}
-interface OsImpl {
-    getProgram(): string;
-    getProgramOptions(opts: ProgramOpts): string[];
-    getCommandFunc(opts: ProgramOpts, fn: (program: string, opts: string[]) => childProcess.ChildProcess): childProcess.ChildProcess;
-    onGetCommandClose(code: number, stdout: string, stderr: string, opts: ProgramOpts, fn: (err: Nullable<Error>, result?: string) => void): Promise<void>;
-    setProgramOptions(opts: ProgramOpts): string[];
-    setCommandFunc(opts: ProgramOpts, fn: (program: string, opts: string[]) => childProcess.ChildProcess): childProcess.ChildProcess;
-    onSetCommandClose(code: number, stdout: string, stderr: string, opts: ProgramOpts, fn: (err: Nullable<Error>) => void): Promise<void>;
-}
-declare enum SecretField {
-    SERVICE = "service",
-    ACCOUNT = "account",
-    KEY = "key"
-}
-declare type SecretContents = {
-    [SecretField.ACCOUNT]: string;
-    [SecretField.KEY]?: string;
-    [SecretField.SERVICE]: string;
-};
-/**
- * @@ignore
- */
-export declare class GenericKeychainAccess implements PasswordStore {
-    getPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, password?: string) => void): Promise<void>;
-    setPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, contents?: SecretContents) => void): Promise<void>;
-    protected isValidFileAccess(cb: (error: Nullable<NodeJS.ErrnoException>) => Promise<void>): Promise<void>;
-}
-/**
- * @ignore
- */
-export declare class GenericUnixKeychainAccess extends GenericKeychainAccess {
-    protected isValidFileAccess(cb: (error: Nullable<Error>) => Promise<void>): Promise<void>;
-}
-/**
- * @ignore
- */
-export declare class GenericWindowsKeychainAccess extends GenericKeychainAccess {
-    protected isValidFileAccess(cb: (error: Nullable<Error>) => Promise<void>): Promise<void>;
-}
-/**
- * @ignore
- */
-export declare const keyChainImpl: {
-    generic_unix: GenericUnixKeychainAccess;
-    generic_windows: GenericWindowsKeychainAccess;
-    darwin: KeychainAccess;
-    linux: KeychainAccess;
-    validateProgram: (programPath: string, fsIfc: FsIfc, isExeIfc: (mode: number, gid: number, uid: number) => boolean) => Promise<void>;
-};
-export declare type KeyChain = GenericUnixKeychainAccess | GenericWindowsKeychainAccess | KeychainAccess;
-export {};
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import * as childProcess from 'child_process';
+import * as nodeFs from 'fs';
+import { Nullable } from '@salesforce/ts-types';
+export declare type FsIfc = Pick<typeof nodeFs, 'statSync'>;
+/**
+ * Basic keychain interface.
+ */
+export interface PasswordStore {
+    /**
+     * Gets a password
+     *
+     * @param opts cli level password options.
+     * @param fn function callback for password.
+     * @param retryCount number of reties to get the password.
+     */
+    getPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, password?: string) => void, retryCount?: number): Promise<void>;
+    /**
+     * Sets a password.
+     *
+     * @param opts cli level password options.
+     * @param fn function callback for password.
+     */
+    setPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, contents?: SecretContents) => void): Promise<void>;
+}
+/**
+ * @private
+ */
+export declare class KeychainAccess implements PasswordStore {
+    private osImpl;
+    private fsIfc;
+    /**
+     * Abstract prototype for general cross platform keychain interaction.
+     *
+     * @param osImpl The platform impl for (linux, darwin, windows).
+     * @param fsIfc The file system interface.
+     */
+    constructor(osImpl: OsImpl, fsIfc: FsIfc);
+    /**
+     * Validates the os level program is executable.
+     */
+    validateProgram(): Promise<void>;
+    /**
+     * Returns a password using the native program for credential management.
+     *
+     * @param opts Options for the credential lookup.
+     * @param fn Callback function (err, password).
+     * @param retryCount Used internally to track the number of retries for getting a password out of the keychain.
+     */
+    getPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, password?: string) => void, retryCount?: number): Promise<void>;
+    /**
+     * Sets a password using the native program for credential management.
+     *
+     * @param opts Options for the credential lookup.
+     * @param fn Callback function (err, ConfigContents).
+     */
+    setPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, contents?: SecretContents) => void): Promise<void>;
+}
+interface ProgramOpts {
+    account: string;
+    service: string;
+    password?: string;
+}
+interface OsImpl {
+    getProgram(): string;
+    getProgramOptions(opts: ProgramOpts): string[];
+    getCommandFunc(opts: ProgramOpts, fn: (program: string, opts: string[]) => childProcess.ChildProcess): childProcess.ChildProcess;
+    onGetCommandClose(code: number, stdout: string, stderr: string, opts: ProgramOpts, fn: (err: Nullable<Error>, result?: string) => void): Promise<void>;
+    setProgramOptions(opts: ProgramOpts): string[];
+    setCommandFunc(opts: ProgramOpts, fn: (program: string, opts: string[]) => childProcess.ChildProcess): childProcess.ChildProcess;
+    onSetCommandClose(code: number, stdout: string, stderr: string, opts: ProgramOpts, fn: (err: Nullable<Error>) => void): Promise<void>;
+}
+declare enum SecretField {
+    SERVICE = "service",
+    ACCOUNT = "account",
+    KEY = "key"
+}
+declare type SecretContents = {
+    [SecretField.ACCOUNT]: string;
+    [SecretField.KEY]?: string;
+    [SecretField.SERVICE]: string;
+};
+/**
+ * @@ignore
+ */
+export declare class GenericKeychainAccess implements PasswordStore {
+    getPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, password?: string) => void): Promise<void>;
+    setPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, contents?: SecretContents) => void): Promise<void>;
+    protected isValidFileAccess(cb: (error: Nullable<NodeJS.ErrnoException>) => Promise<void>): Promise<void>;
+}
+/**
+ * @ignore
+ */
+export declare class GenericUnixKeychainAccess extends GenericKeychainAccess {
+    protected isValidFileAccess(cb: (error: Nullable<Error>) => Promise<void>): Promise<void>;
+}
+/**
+ * @ignore
+ */
+export declare class GenericWindowsKeychainAccess extends GenericKeychainAccess {
+    protected isValidFileAccess(cb: (error: Nullable<Error>) => Promise<void>): Promise<void>;
+}
+/**
+ * @ignore
+ */
+export declare const keyChainImpl: {
+    generic_unix: GenericUnixKeychainAccess;
+    generic_windows: GenericWindowsKeychainAccess;
+    darwin: KeychainAccess;
+    linux: KeychainAccess;
+    validateProgram: (programPath: string, fsIfc: FsIfc, isExeIfc: (mode: number, gid: number, uid: number) => boolean) => Promise<void>;
+};
+export declare type KeyChain = GenericUnixKeychainAccess | GenericWindowsKeychainAccess | KeychainAccess;
+export {};