@salesforce/core 4.0.0 → 4.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +1 -1
- package/README.md +93 -44
- package/lib/config/aliasesConfig.d.ts +12 -0
- package/lib/config/aliasesConfig.js +28 -0
- package/lib/config/authInfoConfig.d.ts +19 -0
- package/lib/config/authInfoConfig.js +35 -0
- package/lib/config/config.d.ts +87 -22
- package/lib/config/config.js +117 -65
- package/lib/config/configAggregator.d.ts +41 -35
- package/lib/config/configAggregator.js +102 -73
- package/lib/config/configFile.d.ts +2 -2
- package/lib/config/configFile.js +38 -29
- package/lib/config/configGroup.d.ts +141 -0
- package/lib/config/configGroup.js +225 -0
- package/lib/config/configStore.d.ts +9 -9
- package/lib/config/configStore.js +17 -15
- package/lib/config/envVars.d.ts +15 -9
- package/lib/config/envVars.js +71 -47
- package/lib/config/orgUsersConfig.js +2 -0
- package/lib/config/sandboxOrgConfig.js +2 -0
- package/lib/config/sandboxProcessCache.d.ts +16 -0
- package/lib/config/sandboxProcessCache.js +38 -0
- package/lib/config/tokensConfig.d.ts +10 -0
- package/lib/config/tokensConfig.js +29 -0
- package/lib/config/ttlConfig.d.ts +34 -0
- package/lib/config/ttlConfig.js +50 -0
- package/lib/crypto/crypto.js +15 -22
- package/lib/crypto/keyChain.js +2 -3
- package/lib/crypto/keyChainImpl.d.ts +5 -3
- package/lib/crypto/keyChainImpl.js +58 -61
- package/lib/crypto/secureBuffer.d.ts +1 -1
- package/lib/deviceOauthService.d.ts +3 -3
- package/lib/deviceOauthService.js +27 -25
- package/lib/exported.d.ts +15 -12
- package/lib/exported.js +28 -16
- package/lib/global.d.ts +11 -3
- package/lib/global.js +39 -12
- package/lib/lifecycleEvents.d.ts +1 -1
- package/lib/lifecycleEvents.js +3 -0
- package/lib/logger.d.ts +19 -9
- package/lib/logger.js +112 -86
- package/lib/messages.d.ts +53 -36
- package/lib/messages.js +81 -91
- package/lib/org/authInfo.d.ts +56 -20
- package/lib/org/authInfo.js +232 -131
- package/lib/org/authRemover.d.ts +8 -7
- package/lib/org/authRemover.js +32 -28
- package/lib/org/connection.d.ts +13 -37
- package/lib/org/connection.js +78 -124
- package/lib/org/index.js +5 -1
- package/lib/org/org.d.ts +151 -48
- package/lib/org/org.js +466 -220
- package/lib/org/orgConfigProperties.d.ts +64 -3
- package/lib/org/orgConfigProperties.js +96 -4
- package/lib/org/permissionSetAssignment.js +4 -13
- package/lib/org/scratchOrgCache.d.ts +20 -0
- package/lib/org/scratchOrgCache.js +33 -0
- package/lib/org/scratchOrgCreate.d.ts +28 -17
- package/lib/org/scratchOrgCreate.js +125 -53
- package/lib/org/scratchOrgErrorCodes.d.ts +9 -3
- package/lib/org/scratchOrgErrorCodes.js +34 -17
- package/lib/org/scratchOrgFeatureDeprecation.js +1 -6
- package/lib/org/scratchOrgInfoApi.d.ts +21 -47
- package/lib/org/scratchOrgInfoApi.js +129 -63
- package/lib/org/scratchOrgInfoGenerator.d.ts +6 -5
- package/lib/org/scratchOrgInfoGenerator.js +76 -62
- package/lib/org/scratchOrgLifecycleEvents.d.ts +10 -0
- package/lib/org/scratchOrgLifecycleEvents.js +41 -0
- package/lib/org/scratchOrgSettingsGenerator.d.ts +44 -21
- package/lib/org/scratchOrgSettingsGenerator.js +165 -98
- package/lib/org/scratchOrgTypes.d.ts +43 -0
- package/lib/org/scratchOrgTypes.js +9 -0
- package/lib/org/user.d.ts +1 -1
- package/lib/org/user.js +25 -34
- package/lib/schema/printer.d.ts +6 -0
- package/lib/schema/printer.js +34 -31
- package/lib/schema/validator.d.ts +12 -10
- package/lib/schema/validator.js +56 -76
- package/lib/{sfdxError.d.ts → sfError.d.ts} +12 -20
- package/lib/{sfdxError.js → sfError.js} +40 -30
- package/lib/{sfdxProject.d.ts → sfProject.d.ts} +75 -35
- package/lib/sfProject.js +651 -0
- package/lib/{globalInfo → stateAggregator}/accessors/aliasAccessor.d.ts +27 -12
- package/lib/{globalInfo → stateAggregator}/accessors/aliasAccessor.js +47 -31
- package/lib/stateAggregator/accessors/orgAccessor.d.ts +101 -0
- package/lib/stateAggregator/accessors/orgAccessor.js +240 -0
- package/lib/stateAggregator/accessors/sandboxAccessor.d.ts +8 -0
- package/lib/stateAggregator/accessors/sandboxAccessor.js +28 -0
- package/lib/stateAggregator/accessors/tokenAccessor.d.ts +63 -0
- package/lib/stateAggregator/accessors/tokenAccessor.js +80 -0
- package/lib/stateAggregator/index.d.ts +4 -0
- package/lib/stateAggregator/index.js +27 -0
- package/lib/stateAggregator/stateAggregator.d.ts +25 -0
- package/lib/stateAggregator/stateAggregator.js +46 -0
- package/lib/status/myDomainResolver.d.ts +1 -1
- package/lib/status/myDomainResolver.js +4 -4
- package/lib/status/pollingClient.js +4 -4
- package/lib/status/streamingClient.d.ts +2 -2
- package/lib/status/streamingClient.js +58 -63
- package/lib/status/types.d.ts +2 -2
- package/lib/testSetup.d.ts +206 -75
- package/lib/testSetup.js +463 -165
- package/lib/util/cache.d.ts +2 -2
- package/lib/util/cache.js +6 -6
- package/lib/util/checkLightningDomain.js +3 -4
- package/lib/util/directoryWriter.d.ts +12 -0
- package/lib/util/directoryWriter.js +54 -0
- package/lib/util/getJwtAudienceUrl.js +1 -1
- package/lib/util/internal.d.ts +28 -2
- package/lib/util/internal.js +65 -8
- package/lib/util/jsonXmlTools.js +2 -4
- package/lib/util/mapKeys.d.ts +9 -9
- package/lib/util/mapKeys.js +13 -9
- package/lib/util/sfdc.d.ts +51 -51
- package/lib/util/sfdc.js +74 -79
- package/lib/util/sfdcUrl.d.ts +5 -19
- package/lib/util/sfdcUrl.js +40 -49
- package/lib/util/structuredWriter.d.ts +9 -0
- package/lib/util/structuredWriter.js +3 -0
- package/lib/util/zipWriter.d.ts +8 -6
- package/lib/util/zipWriter.js +13 -13
- package/lib/webOAuthServer.d.ts +20 -6
- package/lib/webOAuthServer.js +102 -56
- package/messageTransformer/messageTransformer.ts +93 -0
- package/messages/auth.md +9 -1
- package/messages/config.md +42 -6
- package/messages/connection.md +8 -0
- package/messages/core.md +10 -0
- package/messages/envVars.md +37 -3
- package/messages/org.md +21 -1
- package/messages/scratchOrgCreate.md +2 -6
- package/messages/scratchOrgErrorCodes.md +17 -1
- package/messages/scratchOrgInfoApi.md +9 -0
- package/messages/scratchOrgInfoGenerator.md +9 -1
- package/package.json +121 -46
- package/CHANGELOG.md +0 -1244
- package/lib/config/keychainConfig.d.ts +0 -19
- package/lib/config/keychainConfig.js +0 -43
- package/lib/globalInfo/accessors/orgAccessor.d.ts +0 -13
- package/lib/globalInfo/accessors/orgAccessor.js +0 -45
- package/lib/globalInfo/accessors/tokenAccessor.d.ts +0 -13
- package/lib/globalInfo/accessors/tokenAccessor.js +0 -35
- package/lib/globalInfo/globalInfoConfig.d.ts +0 -36
- package/lib/globalInfo/globalInfoConfig.js +0 -105
- package/lib/globalInfo/index.d.ts +0 -6
- package/lib/globalInfo/index.js +0 -29
- package/lib/globalInfo/sfdxDataHandler.d.ts +0 -43
- package/lib/globalInfo/sfdxDataHandler.js +0 -217
- package/lib/globalInfo/types.d.ts +0 -39
- package/lib/globalInfo/types.js +0 -10
- package/lib/sfdxProject.js +0 -557
- package/lib/util/fs.d.ts +0 -201
- package/lib/util/fs.js +0 -378
|
@@ -9,36 +9,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
9
9
|
exports.keyChainImpl = exports.GenericWindowsKeychainAccess = exports.GenericUnixKeychainAccess = exports.GenericKeychainAccess = exports.KeychainAccess = void 0;
|
|
10
10
|
const childProcess = require("child_process");
|
|
11
11
|
const nodeFs = require("fs");
|
|
12
|
+
const fs = require("fs");
|
|
12
13
|
const os = require("os");
|
|
13
|
-
const path = require("path");
|
|
14
14
|
const os_1 = require("os");
|
|
15
|
+
const path = require("path");
|
|
15
16
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
17
|
+
const kit_1 = require("@salesforce/kit");
|
|
16
18
|
const global_1 = require("../global");
|
|
17
|
-
const fs_1 = require("../util/fs");
|
|
18
19
|
const messages_1 = require("../messages");
|
|
19
|
-
messages_1.Messages.
|
|
20
|
-
const messages = messages_1.Messages.load('@salesforce/core', 'encryption', [
|
|
21
|
-
'missingCredentialProgramError',
|
|
22
|
-
'credentialProgramAccessError',
|
|
23
|
-
'keyChainServiceRequiredError',
|
|
24
|
-
'keyChainAccountRequiredError',
|
|
25
|
-
'passwordRetryError',
|
|
26
|
-
'passwordRequiredError',
|
|
27
|
-
'passwordNotFoundError',
|
|
28
|
-
'setCredentialError',
|
|
29
|
-
'keyChainUserCanceledError',
|
|
30
|
-
'genericKeychainServiceError',
|
|
31
|
-
'genericKeychainInvalidPermsError',
|
|
32
|
-
]);
|
|
20
|
+
const messages = new messages_1.Messages('@salesforce/core', 'encryption', new Map([["invalidEncryptedFormatError", "The encrypted data is not properly formatted."], ["invalidEncryptedFormatError.actions", ["If attempting to create a scratch org then re-authorize. Otherwise create a new scratch org."]], ["authDecryptError", "Failed to decipher auth data. reason: %s."], ["unsupportedOperatingSystemError", "Unsupported Operating System: %s"], ["missingCredentialProgramError", "Unable to find required security software: %s"], ["credentialProgramAccessError", "Unable to execute security software: %s"], ["passwordRetryError", "Failed to get the password after %i retries."], ["passwordRequiredError", "A password is required."], ["keyChainServiceRequiredError", "Unable to get or set a keychain value without a service name."], ["keyChainAccountRequiredError", "Unable to get or set a keychain value without an account name."], ["keyChainUserCanceledError", "User canceled authentication."], ["keychainPasswordCreationError", "Failed to create a password in the keychain."], ["genericKeychainServiceError", "The service and account specified in %s do not match the version of the toolbelt."], ["genericKeychainServiceError.actions", ["Check your toolbelt version and re-auth."]], ["genericKeychainInvalidPermsError", "Invalid file permissions for secret file"], ["genericKeychainInvalidPermsError.actions", ["Ensure the file %s has the file permission octal value of %s."]], ["passwordNotFoundError", "Could not find password.\n%s"], ["passwordNotFoundError.actions", ["Ensure a valid password is returned with the following command: [%s]"]], ["setCredentialError", "Command failed with response:\n%s"], ["setCredentialError.actions", ["Determine why this command failed to set an encryption key for user %s: [%s]."]], ["macKeychainOutOfSync", "We\u2019ve encountered an error with the Mac keychain being out of sync with your `sfdx` credentials. To fix the problem, sync your credentials by authenticating into your org again using the auth commands."]]));
|
|
33
21
|
const GET_PASSWORD_RETRY_COUNT = 3;
|
|
34
22
|
/**
|
|
35
23
|
* Helper to reduce an array of cli args down to a presentable string for logging.
|
|
36
24
|
*
|
|
37
25
|
* @param optionsArray CLI command args.
|
|
38
26
|
*/
|
|
39
|
-
|
|
40
|
-
return optionsArray.reduce((accum, element) => `${accum} ${element}`);
|
|
41
|
-
}
|
|
27
|
+
const optionsToString = (optionsArray) => optionsArray.join(' ');
|
|
42
28
|
/**
|
|
43
29
|
* Helper to determine if a program is executable. Returns `true` if the program is executable for the user. For
|
|
44
30
|
* Windows true is always returned.
|
|
@@ -47,7 +33,7 @@ function _optionsToString(optionsArray) {
|
|
|
47
33
|
* @param gid Unix group id.
|
|
48
34
|
* @param uid Unix user id.
|
|
49
35
|
*/
|
|
50
|
-
const
|
|
36
|
+
const isExe = (mode, gid, uid) => {
|
|
51
37
|
if (process.platform === 'win32') {
|
|
52
38
|
return true;
|
|
53
39
|
}
|
|
@@ -58,15 +44,18 @@ const _isExe = (mode, gid, uid) => {
|
|
|
58
44
|
/**
|
|
59
45
|
* Private helper to validate that a program exists on the file system and is executable.
|
|
60
46
|
*
|
|
61
|
-
* **Throws** *{@link
|
|
47
|
+
* **Throws** *{@link SfError}{ name: 'MissingCredentialProgramError' }* When the OS credential program isn't found.
|
|
62
48
|
*
|
|
63
|
-
* **Throws** *{@link
|
|
49
|
+
* **Throws** *{@link SfError}{ name: 'CredentialProgramAccessError' }* When the OS credential program isn't accessible.
|
|
64
50
|
*
|
|
65
51
|
* @param programPath The absolute path of the program.
|
|
66
52
|
* @param fsIfc The file system interface.
|
|
67
53
|
* @param isExeIfc Executable validation function.
|
|
68
54
|
*/
|
|
69
|
-
|
|
55
|
+
// eslint-disable-next-line no-underscore-dangle
|
|
56
|
+
const _validateProgram = async (programPath, fsIfc, isExeIfc
|
|
57
|
+
// eslint-disable-next-line @typescript-eslint/require-await
|
|
58
|
+
) => {
|
|
70
59
|
let noPermission;
|
|
71
60
|
try {
|
|
72
61
|
const stats = fsIfc.statSync(programPath);
|
|
@@ -97,7 +86,7 @@ class KeychainAccess {
|
|
|
97
86
|
* Validates the os level program is executable.
|
|
98
87
|
*/
|
|
99
88
|
async validateProgram() {
|
|
100
|
-
await _validateProgram(this.osImpl.getProgram(), this.fsIfc,
|
|
89
|
+
await _validateProgram(this.osImpl.getProgram(), this.fsIfc, isExe);
|
|
101
90
|
}
|
|
102
91
|
/**
|
|
103
92
|
* Returns a password using the native program for credential management.
|
|
@@ -135,6 +124,7 @@ class KeychainAccess {
|
|
|
135
124
|
return await this.osImpl.onGetCommandClose(code, stdout, stderr, opts, fn);
|
|
136
125
|
}
|
|
137
126
|
catch (e) {
|
|
127
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
138
128
|
// @ts-ignore
|
|
139
129
|
if (e.retry) {
|
|
140
130
|
if (retryCount >= GET_PASSWORD_RETRY_COUNT) {
|
|
@@ -171,7 +161,7 @@ class KeychainAccess {
|
|
|
171
161
|
fn(messages.createError('passwordRequiredError'));
|
|
172
162
|
return;
|
|
173
163
|
}
|
|
174
|
-
await _validateProgram(this.osImpl.getProgram(), this.fsIfc,
|
|
164
|
+
await _validateProgram(this.osImpl.getProgram(), this.fsIfc, isExe);
|
|
175
165
|
const credManager = this.osImpl.setCommandFunc(opts, childProcess.spawn);
|
|
176
166
|
let stdout = '';
|
|
177
167
|
let stderr = '';
|
|
@@ -187,7 +177,7 @@ class KeychainAccess {
|
|
|
187
177
|
}
|
|
188
178
|
credManager.on('close',
|
|
189
179
|
// eslint-disable-next-line @typescript-eslint/no-misused-promises
|
|
190
|
-
async (code) =>
|
|
180
|
+
async (code) => this.osImpl.onSetCommandClose(code, stdout, stderr, opts, fn));
|
|
191
181
|
if (credManager.stdin) {
|
|
192
182
|
credManager.stdin.end();
|
|
193
183
|
}
|
|
@@ -199,23 +189,25 @@ exports.KeychainAccess = KeychainAccess;
|
|
|
199
189
|
*
|
|
200
190
|
* Uses libsecret.
|
|
201
191
|
*/
|
|
202
|
-
const
|
|
192
|
+
const linuxImpl = {
|
|
203
193
|
getProgram() {
|
|
204
|
-
return process.env.SFDX_SECRET_TOOL_PATH
|
|
194
|
+
return process.env.SFDX_SECRET_TOOL_PATH ?? path.join(path.sep, 'usr', 'bin', 'secret-tool');
|
|
205
195
|
},
|
|
206
196
|
getProgramOptions(opts) {
|
|
207
197
|
return ['lookup', 'user', opts.account, 'domain', opts.service];
|
|
208
198
|
},
|
|
209
199
|
getCommandFunc(opts, fn) {
|
|
210
|
-
return fn(
|
|
200
|
+
return fn(linuxImpl.getProgram(), linuxImpl.getProgramOptions(opts));
|
|
211
201
|
},
|
|
202
|
+
// eslint-disable-next-line @typescript-eslint/require-await
|
|
212
203
|
async onGetCommandClose(code, stdout, stderr, opts, fn) {
|
|
213
204
|
if (code === 1) {
|
|
214
|
-
const command = `${
|
|
205
|
+
const command = `${linuxImpl.getProgram()} ${optionsToString(linuxImpl.getProgramOptions(opts))}`;
|
|
215
206
|
const error = messages.createError('passwordNotFoundError', [], [command]);
|
|
216
207
|
// This is a workaround for linux.
|
|
217
208
|
// Calling secret-tool too fast can cause it to return an unexpected error. (below)
|
|
218
|
-
if (stderr
|
|
209
|
+
if (stderr?.includes('invalid or unencryptable secret')) {
|
|
210
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
219
211
|
// @ts-ignore TODO: make an error subclass with this field
|
|
220
212
|
error.retry = true;
|
|
221
213
|
// Throwing here allows us to perform a retry in KeychainAccess
|
|
@@ -232,15 +224,16 @@ const _linuxImpl = {
|
|
|
232
224
|
return ['store', "--label='salesforce.com'", 'user', opts.account, 'domain', opts.service];
|
|
233
225
|
},
|
|
234
226
|
setCommandFunc(opts, fn) {
|
|
235
|
-
const secretTool = fn(
|
|
227
|
+
const secretTool = fn(linuxImpl.getProgram(), linuxImpl.setProgramOptions(opts));
|
|
236
228
|
if (secretTool.stdin) {
|
|
237
229
|
secretTool.stdin.write(`${opts.password}\n`);
|
|
238
230
|
}
|
|
239
231
|
return secretTool;
|
|
240
232
|
},
|
|
233
|
+
// eslint-disable-next-line @typescript-eslint/require-await
|
|
241
234
|
async onSetCommandClose(code, stdout, stderr, opts, fn) {
|
|
242
235
|
if (code !== 0) {
|
|
243
|
-
const command = `${
|
|
236
|
+
const command = `${linuxImpl.getProgram()} ${optionsToString(linuxImpl.setProgramOptions(opts))}`;
|
|
244
237
|
fn(messages.createError('setCredentialError', [`${stdout} - ${stderr}`], [os.userInfo().username, command]));
|
|
245
238
|
}
|
|
246
239
|
else {
|
|
@@ -253,7 +246,7 @@ const _linuxImpl = {
|
|
|
253
246
|
*
|
|
254
247
|
* /usr/bin/security is a cli front end for OSX keychain.
|
|
255
248
|
*/
|
|
256
|
-
const
|
|
249
|
+
const darwinImpl = {
|
|
257
250
|
getProgram() {
|
|
258
251
|
return path.join(path.sep, 'usr', 'bin', 'security');
|
|
259
252
|
},
|
|
@@ -261,8 +254,9 @@ const _darwinImpl = {
|
|
|
261
254
|
return ['find-generic-password', '-a', opts.account, '-s', opts.service, '-g'];
|
|
262
255
|
},
|
|
263
256
|
getCommandFunc(opts, fn) {
|
|
264
|
-
return fn(
|
|
257
|
+
return fn(darwinImpl.getProgram(), darwinImpl.getProgramOptions(opts));
|
|
265
258
|
},
|
|
259
|
+
// eslint-disable-next-line @typescript-eslint/require-await
|
|
266
260
|
async onGetCommandClose(code, stdout, stderr, opts, fn) {
|
|
267
261
|
let err;
|
|
268
262
|
if (code !== 0) {
|
|
@@ -272,7 +266,7 @@ const _darwinImpl = {
|
|
|
272
266
|
break;
|
|
273
267
|
}
|
|
274
268
|
default: {
|
|
275
|
-
const command = `${
|
|
269
|
+
const command = `${darwinImpl.getProgram()} ${optionsToString(darwinImpl.getProgramOptions(opts))}`;
|
|
276
270
|
err = messages.createError('passwordNotFoundError', [`${stdout} - ${stderr}`], [command]);
|
|
277
271
|
}
|
|
278
272
|
}
|
|
@@ -283,7 +277,7 @@ const _darwinImpl = {
|
|
|
283
277
|
// stdout. Reference: http://blog.macromates.com/2006/keychain-access-from-shell/
|
|
284
278
|
if (stderr.includes('password')) {
|
|
285
279
|
const match = RegExp(/"(.*)"/).exec(stderr);
|
|
286
|
-
if (!match
|
|
280
|
+
if (!match?.[1]) {
|
|
287
281
|
fn(messages.createError('passwordNotFoundError', [`${stdout} - ${stderr}`]));
|
|
288
282
|
}
|
|
289
283
|
else {
|
|
@@ -291,7 +285,7 @@ const _darwinImpl = {
|
|
|
291
285
|
}
|
|
292
286
|
}
|
|
293
287
|
else {
|
|
294
|
-
const command = `${
|
|
288
|
+
const command = `${darwinImpl.getProgram()} ${optionsToString(darwinImpl.getProgramOptions(opts))}`;
|
|
295
289
|
fn(messages.createError('passwordNotFoundError', [`${stdout} - ${stderr}`], [command]));
|
|
296
290
|
}
|
|
297
291
|
},
|
|
@@ -303,11 +297,12 @@ const _darwinImpl = {
|
|
|
303
297
|
return result;
|
|
304
298
|
},
|
|
305
299
|
setCommandFunc(opts, fn) {
|
|
306
|
-
return fn(
|
|
300
|
+
return fn(darwinImpl.getProgram(), darwinImpl.setProgramOptions(opts));
|
|
307
301
|
},
|
|
302
|
+
// eslint-disable-next-line @typescript-eslint/require-await
|
|
308
303
|
async onSetCommandClose(code, stdout, stderr, opts, fn) {
|
|
309
304
|
if (code !== 0) {
|
|
310
|
-
const command = `${
|
|
305
|
+
const command = `${darwinImpl.getProgram()} ${optionsToString(darwinImpl.setProgramOptions(opts))}`;
|
|
311
306
|
fn(messages.createError('setCredentialError', [`${stdout} - ${stderr}`], [os.userInfo().username, command]));
|
|
312
307
|
}
|
|
313
308
|
else {
|
|
@@ -315,31 +310,32 @@ const _darwinImpl = {
|
|
|
315
310
|
}
|
|
316
311
|
},
|
|
317
312
|
};
|
|
318
|
-
const
|
|
313
|
+
const getSecretFile = () => path.join(global_1.Global.DIR, 'key.json');
|
|
319
314
|
var SecretField;
|
|
320
315
|
(function (SecretField) {
|
|
321
316
|
SecretField["SERVICE"] = "service";
|
|
322
317
|
SecretField["ACCOUNT"] = "account";
|
|
323
318
|
SecretField["KEY"] = "key";
|
|
324
319
|
})(SecretField || (SecretField = {}));
|
|
325
|
-
async function
|
|
320
|
+
async function writeFile(opts, fn) {
|
|
326
321
|
try {
|
|
327
322
|
const contents = {
|
|
328
323
|
[SecretField.ACCOUNT]: opts.account,
|
|
329
324
|
[SecretField.KEY]: opts.password,
|
|
330
325
|
[SecretField.SERVICE]: opts.service,
|
|
331
326
|
};
|
|
332
|
-
|
|
333
|
-
await
|
|
327
|
+
const secretFile = getSecretFile();
|
|
328
|
+
await fs.promises.mkdir(path.dirname(secretFile), { recursive: true });
|
|
329
|
+
await fs.promises.writeFile(secretFile, JSON.stringify(contents, null, 4), { mode: '600' });
|
|
334
330
|
fn(null, contents);
|
|
335
331
|
}
|
|
336
332
|
catch (err) {
|
|
337
333
|
fn(err);
|
|
338
334
|
}
|
|
339
335
|
}
|
|
340
|
-
async function
|
|
336
|
+
async function readFile() {
|
|
341
337
|
// The file and access is validated before this method is called
|
|
342
|
-
const fileContents = await
|
|
338
|
+
const fileContents = (0, kit_1.parseJsonMap)(await fs.promises.readFile(getSecretFile(), 'utf8'));
|
|
343
339
|
return {
|
|
344
340
|
account: (0, ts_types_1.ensureString)(fileContents[SecretField.ACCOUNT]),
|
|
345
341
|
password: (0, ts_types_1.asString)(fileContents[SecretField.KEY]),
|
|
@@ -358,7 +354,7 @@ class GenericKeychainAccess {
|
|
|
358
354
|
if (fileAccessError == null) {
|
|
359
355
|
// read it's contents
|
|
360
356
|
try {
|
|
361
|
-
const { service, account, password } = await
|
|
357
|
+
const { service, account, password } = await readFile();
|
|
362
358
|
// validate service name and account just because
|
|
363
359
|
if (opts.service === service && opts.account === account) {
|
|
364
360
|
fn(null, password);
|
|
@@ -366,20 +362,18 @@ class GenericKeychainAccess {
|
|
|
366
362
|
else {
|
|
367
363
|
// if the service and account names don't match then maybe someone or something is editing
|
|
368
364
|
// that file. #donotallow
|
|
369
|
-
fn(messages.createError('genericKeychainServiceError', [
|
|
365
|
+
fn(messages.createError('genericKeychainServiceError', [getSecretFile()]));
|
|
370
366
|
}
|
|
371
367
|
}
|
|
372
368
|
catch (readJsonErr) {
|
|
373
369
|
fn(readJsonErr);
|
|
374
370
|
}
|
|
375
371
|
}
|
|
372
|
+
else if (fileAccessError.code === 'ENOENT') {
|
|
373
|
+
fn(messages.createError('passwordNotFoundError'));
|
|
374
|
+
}
|
|
376
375
|
else {
|
|
377
|
-
|
|
378
|
-
fn(messages.createError('passwordNotFoundError'));
|
|
379
|
-
}
|
|
380
|
-
else {
|
|
381
|
-
fn(fileAccessError);
|
|
382
|
-
}
|
|
376
|
+
fn(fileAccessError);
|
|
383
377
|
}
|
|
384
378
|
});
|
|
385
379
|
}
|
|
@@ -391,7 +385,7 @@ class GenericKeychainAccess {
|
|
|
391
385
|
// file not found
|
|
392
386
|
if (fileAccessError.code === 'ENOENT') {
|
|
393
387
|
// create the file
|
|
394
|
-
await
|
|
388
|
+
await writeFile.call(this, opts, fn);
|
|
395
389
|
}
|
|
396
390
|
else {
|
|
397
391
|
fn(fileAccessError);
|
|
@@ -399,14 +393,15 @@ class GenericKeychainAccess {
|
|
|
399
393
|
}
|
|
400
394
|
else {
|
|
401
395
|
// the existing file validated. we can write the updated key
|
|
402
|
-
await
|
|
396
|
+
await writeFile.call(this, opts, fn);
|
|
403
397
|
}
|
|
404
398
|
});
|
|
405
399
|
}
|
|
400
|
+
// eslint-disable-next-line class-methods-use-this
|
|
406
401
|
async isValidFileAccess(cb) {
|
|
407
402
|
try {
|
|
408
403
|
const root = (0, os_1.homedir)();
|
|
409
|
-
await
|
|
404
|
+
await fs.promises.access(path.join(root, global_1.Global.SFDX_STATE_FOLDER), fs.constants.R_OK | fs.constants.X_OK | fs.constants.W_OK);
|
|
410
405
|
await cb(null);
|
|
411
406
|
}
|
|
412
407
|
catch (err) {
|
|
@@ -426,13 +421,15 @@ class GenericUnixKeychainAccess extends GenericKeychainAccess {
|
|
|
426
421
|
await cb(err);
|
|
427
422
|
}
|
|
428
423
|
else {
|
|
429
|
-
const
|
|
424
|
+
const secretFile = getSecretFile();
|
|
425
|
+
const stats = await fs.promises.stat(secretFile);
|
|
430
426
|
const octalModeStr = (stats.mode & 0o777).toString(8);
|
|
431
427
|
const EXPECTED_OCTAL_PERM_VALUE = '600';
|
|
432
428
|
if (octalModeStr === EXPECTED_OCTAL_PERM_VALUE) {
|
|
433
429
|
await cb(null);
|
|
434
430
|
}
|
|
435
431
|
else {
|
|
432
|
+
// eslint-disable-next-line @typescript-eslint/no-floating-promises
|
|
436
433
|
cb(messages.createError('genericKeychainInvalidPermsError', [secretFile], [secretFile, EXPECTED_OCTAL_PERM_VALUE]));
|
|
437
434
|
}
|
|
438
435
|
}
|
|
@@ -451,7 +448,7 @@ class GenericWindowsKeychainAccess extends GenericKeychainAccess {
|
|
|
451
448
|
}
|
|
452
449
|
else {
|
|
453
450
|
try {
|
|
454
|
-
await
|
|
451
|
+
await fs.promises.access(getSecretFile(), fs.constants.R_OK | fs.constants.W_OK);
|
|
455
452
|
await cb(null);
|
|
456
453
|
}
|
|
457
454
|
catch (e) {
|
|
@@ -470,8 +467,8 @@ exports.keyChainImpl = {
|
|
|
470
467
|
generic_unix: new GenericUnixKeychainAccess(),
|
|
471
468
|
// eslint-disable-next-line camelcase
|
|
472
469
|
generic_windows: new GenericWindowsKeychainAccess(),
|
|
473
|
-
darwin: new KeychainAccess(
|
|
474
|
-
linux: new KeychainAccess(
|
|
470
|
+
darwin: new KeychainAccess(darwinImpl, nodeFs),
|
|
471
|
+
linux: new KeychainAccess(linuxImpl, nodeFs),
|
|
475
472
|
validateProgram: _validateProgram,
|
|
476
473
|
};
|
|
477
474
|
//# sourceMappingURL=keyChainImpl.js.map
|
|
@@ -5,7 +5,7 @@ import { Optional } from '@salesforce/ts-types';
|
|
|
5
5
|
*
|
|
6
6
|
* @param buffer A buffer containing the decrypted secret.
|
|
7
7
|
*/
|
|
8
|
-
export
|
|
8
|
+
export type DecipherCallback<T> = (buffer: Buffer) => T;
|
|
9
9
|
/**
|
|
10
10
|
* Used to store and retrieve a sensitive information in memory. This is not meant for at rest encryption.
|
|
11
11
|
*
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { AsyncCreatable } from '@salesforce/kit';
|
|
2
|
-
import { OAuth2Config } from 'jsforce
|
|
3
|
-
import {
|
|
4
|
-
import { AuthInfo } from './org
|
|
2
|
+
import { OAuth2Config } from 'jsforce';
|
|
3
|
+
import { JsonMap, Nullable } from '@salesforce/ts-types';
|
|
4
|
+
import { AuthInfo } from './org';
|
|
5
5
|
export interface DeviceCodeResponse extends JsonMap {
|
|
6
6
|
device_code: string;
|
|
7
7
|
interval: number;
|
|
@@ -9,17 +9,15 @@
|
|
|
9
9
|
/* eslint-disable @typescript-eslint/ban-types */
|
|
10
10
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11
11
|
exports.DeviceOauthService = void 0;
|
|
12
|
-
const url_1 = require("url");
|
|
13
12
|
const transport_1 = require("jsforce/lib/transport");
|
|
14
13
|
const kit_1 = require("@salesforce/kit");
|
|
15
14
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
15
|
+
const FormData = require("form-data");
|
|
16
16
|
const logger_1 = require("./logger");
|
|
17
|
-
const
|
|
18
|
-
const
|
|
19
|
-
const connection_1 = require("./org/connection");
|
|
17
|
+
const org_1 = require("./org");
|
|
18
|
+
const sfError_1 = require("./sfError");
|
|
20
19
|
const messages_1 = require("./messages");
|
|
21
|
-
messages_1.Messages.importMessagesDirectory(__dirname);
|
|
22
|
-
const messages = messages_1.Messages.load('@salesforce/core', 'auth', ['pollingTimeout']);
|
|
20
|
+
const messages = new messages_1.Messages('@salesforce/core', 'auth', new Map([["targetOrgNotSet", "A default user is not set."], ["targetOrgNotSet.actions", ["Run the \"sfdx auth\" commands with --setdefaultusername to connect to an org and set it as your default org.", "Run \"force:org:create\" with --setdefaultusername to create a scratch org and set it as your default org.", "Run \"sfdx config:set defaultusername=<username>\" to set your default username."]], ["portInUse", "Cannot start the OAuth redirect server on port %s."], ["portInUse.actions", ["Kill the process running on port %s or use a custom connected app and update OauthLocalPort in the sfdx-project.json file."]], ["invalidRequestMethod", "Invalid request method: %s"], ["invalidRequestUri", "Invalid request uri: %s"], ["pollingTimeout", "The device authorization request timed out. After executing force:auth:device:login, you must approve access to the device within 10 minutes. This can happen if the URL wasn\u2019t copied into the browser, login was not attempted, or the 2FA process was not completed within 10 minutes. Request authorization again."], ["serverErrorHTMLResponse", "<html><head><style>body {background-color:#F4F6F9; font-family: Arial, sans-serif; font-size: 0.8125rem; line-height: 1.5rem; color: #16325c;} #center {margin: auto; width: 370px; padding: 100px 0px 20px;} #logo-container {margin-left: auto; margin-right: auto; text-align: center;} #logo {max-width: 180px; max-height: 113px; margin-bottom: 2rem; border: 0;} #header {font-size: 1.5rem; text-align: center; margin-bottom: 1rem;} #message {background-color: #FFFFFF; margin: 0px auto; padding: 1.25rem; border-radius: 0.25rem; border: 1px solid #D8DDE6;} #footer {height: 24px; width: 370px; text-align: center; font-size: .75rem; position: absolute; bottom: 10;}</style></head><body><div id=\"center\"><div id=\"logo-container\"><img id=\"logo\" aria-hidden=\"true\" name=\"logo\" alt=\"Salesforce\" src=\"data:image/svg+xml;base64,%s\"></div><div id=\"header\">%s</div><div id=\"message\">%s<br/><br/>This is most likely <b>not</b> an error with the Salesforce CLI. Please ensure all information is accurate and try again.</div><div id=\"footer\">© %s Salesforce, Inc. All rights reserved.</div></div></body></html>"], ["missingAuthCode", "No authentication code found on login response."], ["serverSuccessHTMLResponse", "<html><head><style>body {background-color:#F4F6F9; font-family: Arial, sans-serif; font-size: 0.8125rem; line-height: 1.5rem; color: #16325c;} #center {margin: auto; width: 300px; padding: 100px 0px 20px;} #logo-container {margin-left: auto; margin-right: auto; text-align: center;} #logo {max-width: 180px; max-height: 113px; margin-bottom: 2rem; border: 0;} #header {font-size: 1.5rem; text-align: center; margin-bottom: 1rem;} #message {background-color: #FFFFFF; margin: 0px auto; padding: 1.25rem; border-radius: 0.25rem; border: 1px solid #D8DDE6;} #footer {height: 24px; width: 300px; text-align: center; font-size: .75rem; position: absolute; bottom: 10;}</style></head><body><div id=\"center\"><div id=\"logo-container\"><img id=\"logo\" aria-hidden=\"true\" name=\"logo\" alt=\"Salesforce\" src=\"data:image/svg+xml;base64,%s\"></div><div id=\"header\">Authentication Successful</div><div id=\"message\">You've successfully logged in. You can now close this browser tab or window.</div><div id=\"footer\">© %s Salesforce, Inc. All rights reserved.</div></div></body></html>"], ["serverSfdcImage", "<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 21.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
	 viewBox="0 0 262 184" style="enable-background:new 0 0 262 184;" xml:space="preserve">
<style type="text/css">
	.st0{fill:#00A1E0;}
	.st1{fill:#FFFFFF;}
</style>
<title>logo-salesforce</title>
<desc>Created with Sketch.</desc>
<g id="Test-B">
	<g id="Mobile-Nav---Test-B-_x28_0_x29_">
		<g id="Group">
			<g id="logo-salesforce">
				<path id="Fill-1" class="st0" d="M109.2,20.9c8.4-8.7,20.1-14.2,33-14.2c17.2,0,32.1,9.6,40.1,23.8c6.9-3.1,14.6-4.8,22.7-4.8
					c31,0,56,25.3,56,56.5s-25.1,56.5-56,56.5c-3.8,0-7.5-0.4-11-1.1c-7,12.5-20.4,21-35.8,21c-6.4,0-12.5-1.5-17.9-4.1
					c-7.1,16.7-23.7,28.5-43,28.5c-20.1,0-37.3-12.7-43.9-30.6c-2.9,0.6-5.9,0.9-8.9,0.9c-24,0-43.4-19.6-43.4-43.9
					c0-16.2,8.7-30.4,21.7-38c-2.7-6.1-4.2-12.9-4.2-20.1C18.5,23.6,41.2,1,69,1C85.4,1,100,8.8,109.2,20.9"/>
				<path id="Combined-Shape" class="st1" d="M38.7,95.4l1.1-2.9c0.2-0.5,0.5-0.3,0.7-0.2c0.3,0.2,0.5,0.3,0.9,0.6c3.1,2,6,2,6.9,2
					c2.3,0,3.8-1.2,3.8-2.9v-0.1c0-1.8-2.2-2.5-4.8-3.3l-0.6-0.2c-3.5-1-7.3-2.5-7.3-6.9v-0.1c0-4.2,3.4-7.2,8.3-7.2l0.5,0
					c2.9,0,5.6,0.8,7.6,2.1c0.2,0.1,0.4,0.3,0.3,0.6c-0.1,0.3-1,2.6-1.1,2.9c-0.2,0.5-0.7,0.2-0.7,0.2c-1.8-1-4.5-1.7-6.8-1.7
					c-2.1,0-3.4,1.1-3.4,2.6v0.1c0,1.7,2.3,2.5,4.9,3.3l0.5,0.1c3.5,1.1,7.2,2.6,7.2,6.9v0.1c0,4.6-3.3,7.4-8.6,7.4
					c-2.6,0-5.1-0.4-7.8-1.8c-0.5-0.3-1-0.5-1.5-0.9C38.7,95.9,38.5,95.8,38.7,95.4z M116.7,95.4l1.1-2.9c0.2-0.5,0.6-0.3,0.7-0.2
					c0.3,0.2,0.5,0.3,0.9,0.6c3.1,2,6,2,6.9,2c2.3,0,3.8-1.2,3.8-2.9v-0.1c0-1.8-2.2-2.5-4.8-3.3l-0.6-0.2c-3.5-1-7.3-2.5-7.3-6.9
					v-0.1c0-4.2,3.4-7.2,8.3-7.2l0.5,0c2.9,0,5.6,0.8,7.6,2.1c0.2,0.1,0.4,0.3,0.3,0.6c-0.1,0.3-1,2.6-1.1,2.9
					c-0.2,0.5-0.7,0.2-0.7,0.2c-1.8-1-4.5-1.7-6.8-1.7c-2.1,0-3.4,1.1-3.4,2.6v0.1c0,1.7,2.3,2.5,4.9,3.3l0.5,0.1
					c3.5,1.1,7.2,2.6,7.2,6.9v0.1c0,4.6-3.3,7.4-8.6,7.4c-2.6,0-5.1-0.4-7.8-1.8c-0.5-0.3-1-0.5-1.5-0.9
					C116.8,95.9,116.6,95.8,116.7,95.4z M174.5,81.7c0.4,1.5,0.7,3.1,0.7,4.8s-0.2,3.3-0.7,4.8c-0.4,1.5-1.1,2.8-2,3.9
					c-0.9,1.1-2.1,2-3.4,2.6c-1.4,0.6-3,0.9-4.8,0.9c-1.8,0-3.4-0.3-4.8-0.9c-1.4-0.6-2.5-1.5-3.4-2.6c-0.9-1.1-1.6-2.4-2-3.9
					c-0.4-1.5-0.7-3.1-0.7-4.8c0-1.7,0.2-3.3,0.7-4.8c0.4-1.5,1.1-2.8,2-3.9c0.9-1.1,2.1-2,3.4-2.6c1.4-0.6,3-1,4.8-1
					c1.8,0,3.4,0.3,4.8,1c1.4,0.6,2.5,1.5,3.4,2.6C173.4,78.9,174.1,80.2,174.5,81.7z M170,86.4c0-2.6-0.5-4.6-1.4-6
					c-0.9-1.4-2.4-2.1-4.3-2.1c-2,0-3.4,0.7-4.3,2.1c-0.9,1.4-1.4,3.4-1.4,6c0,2.6,0.5,4.6,1.4,6.1c0.9,1.4,2.3,2.1,4.3,2.1
					c2,0,3.4-0.7,4.3-2.1C169.6,91.1,170,89,170,86.4z M211.1,93.9l1.1,3c0.1,0.4-0.2,0.5-0.2,0.5c-1.7,0.7-4,1.1-6.3,1.1
					c-3.9,0-6.8-1.1-8.8-3.3c-2-2.2-3-5.2-3-8.9c0-1.7,0.2-3.3,0.7-4.8c0.5-1.5,1.2-2.8,2.2-3.9c1-1.1,2.2-2,3.6-2.6
					c1.4-0.6,3.1-1,5-1c1.3,0,2.4,0.1,3.3,0.2c1,0.2,2.4,0.5,3,0.8c0.1,0,0.4,0.2,0.3,0.5c-0.4,1.2-0.7,2-1.1,3
					c-0.2,0.5-0.5,0.3-0.5,0.3c-1.5-0.5-2.9-0.7-4.7-0.7c-2.2,0-3.9,0.7-4.9,2.2c-1.1,1.4-1.7,3.3-1.7,5.9c0,2.8,0.7,4.8,1.9,6.1
					c1.2,1.3,2.9,1.9,5.1,1.9c0.9,0,1.7-0.1,2.4-0.2c0.7-0.1,1.4-0.3,2.1-0.6C210.5,93.6,210.9,93.5,211.1,93.9z M233.8,80.8
					c1,3.4,0.5,6.3,0.4,6.5c0,0.4-0.4,0.4-0.4,0.4l-15.1,0c0.1,2.3,0.6,3.9,1.8,5c1.1,1.1,2.8,1.8,5.2,1.8c3.6,0,5.1-0.7,6.2-1.1
					c0,0,0.4-0.1,0.6,0.3l1,2.8c0.2,0.5,0,0.6-0.1,0.7c-0.9,0.5-3.2,1.5-7.6,1.5c-2.1,0-4-0.3-5.5-0.9c-1.5-0.6-2.8-1.4-3.8-2.5
					c-1-1.1-1.7-2.4-2.2-3.8c-0.5-1.5-0.7-3.1-0.7-4.8c0-1.7,0.2-3.3,0.7-4.8c0.4-1.5,1.1-2.8,2-3.9c0.9-1.1,2.1-2,3.5-2.6
					c1.4-0.7,3.1-1,5-1c1.6,0,3.1,0.3,4.3,0.9c0.9,0.4,1.9,1.1,2.9,2.2C232.5,77.9,233.4,79.4,233.8,80.8z M218.8,84h10.7
					c-0.1-1.4-0.4-2.6-1-3.6c-0.9-1.4-2.2-2.2-4.2-2.2c-2,0-3.4,0.8-4.3,2.2C219.4,81.3,219.1,82.5,218.8,84z M113.1,80.8
					c1,3.4,0.5,6.3,0.5,6.5c0,0.4-0.4,0.4-0.4,0.4l-15.1,0c0.1,2.3,0.6,3.9,1.8,5c1.1,1.1,2.8,1.8,5.2,1.8c3.6,0,5.1-0.7,6.2-1.1
					c0,0,0.4-0.1,0.6,0.3l1,2.8c0.2,0.5,0,0.6-0.1,0.7c-0.9,0.5-3.2,1.5-7.6,1.5c-2.1,0-4-0.3-5.5-0.9c-1.5-0.6-2.8-1.4-3.8-2.5
					c-1-1.1-1.7-2.4-2.2-3.8c-0.5-1.5-0.7-3.1-0.7-4.8c0-1.7,0.2-3.3,0.7-4.8c0.4-1.5,1.1-2.8,2-3.9c0.9-1.1,2.1-2,3.5-2.6
					c1.4-0.7,3.1-1,5-1c1.6,0,3.1,0.3,4.3,0.9c0.9,0.4,1.9,1.1,2.9,2.2C111.8,77.9,112.8,79.4,113.1,80.8z M98.1,84h10.8
					c-0.1-1.4-0.4-2.6-1-3.6c-0.9-1.4-2.2-2.2-4.2-2.2c-2,0-3.4,0.8-4.3,2.2C98.7,81.3,98.4,82.5,98.1,84z M71.6,83.2
					c0,0,1.2,0.1,2.5,0.3v-0.6c0-2-0.4-3-1.2-3.6c-0.8-0.6-2.1-1-3.7-1c0,0-3.7,0-6.6,1.5c-0.1,0.1-0.2,0.1-0.2,0.1
					s-0.4,0.1-0.5-0.2l-1.1-2.9c-0.2-0.4,0.1-0.6,0.1-0.6c1.4-1.1,4.6-1.7,4.6-1.7c1.1-0.2,2.9-0.4,4-0.4c3,0,5.3,0.7,6.9,2.1
					c1.6,1.4,2.4,3.6,2.4,6.7l0,13.8c0,0,0,0.4-0.3,0.5c0,0-0.6,0.2-1.1,0.3c-0.5,0.1-2.3,0.5-3.8,0.7c-1.5,0.3-3,0.4-4.6,0.4
					c-1.5,0-2.8-0.1-4-0.4c-1.2-0.3-2.2-0.7-3.1-1.3c-0.8-0.6-1.5-1.4-2-2.4c-0.5-0.9-0.7-2.1-0.7-3.4c0-1.3,0.3-2.5,0.8-3.5
					c0.5-1,1.3-1.8,2.2-2.5c0.9-0.7,2-1.1,3.1-1.5c1.2-0.3,2.4-0.5,3.7-0.5C70.2,83.2,71,83.2,71.6,83.2z M65.6,93.8
					c0,0,1.4,1.1,4.4,0.9c2.2-0.1,4.1-0.5,4.1-0.5v-6.9c0,0-1.9-0.3-4.1-0.3c-3.1,0-4.4,1.1-4.4,1.1c-0.9,0.6-1.3,1.6-1.3,2.9
					c0,0.8,0.2,1.5,0.5,2C64.9,93.2,65,93.4,65.6,93.8z M193.1,75.5c-0.1,0.4-0.9,2.5-1.1,3.2c-0.1,0.3-0.3,0.4-0.6,0.4
					c0,0-0.9-0.2-1.7-0.2c-0.5,0-1.3,0.1-2,0.3c-0.7,0.2-1.3,0.6-1.9,1.1c-0.6,0.5-1,1.3-1.3,2.2c-0.3,0.9-0.5,2.4-0.5,4v11.2
					c0,0.3-0.2,0.5-0.5,0.5h-4c-0.3,0-0.5-0.2-0.5-0.5V75.2c0-0.3,0.2-0.5,0.4-0.5h3.9c0.3,0,0.4,0.2,0.4,0.5V77
					c0.6-0.8,1.6-1.5,2.5-1.9c0.9-0.4,2-0.7,3.9-0.6c1,0.1,2.3,0.3,2.5,0.4C193,75,193.2,75.1,193.1,75.5z M156,65.1
					c0.1,0,0.4,0.2,0.3,0.5l-1.2,3.2c-0.1,0.2-0.2,0.4-0.7,0.2c-0.1,0-0.3-0.1-0.8-0.2c-0.3-0.1-0.8-0.1-1.2-0.1
					c-0.6,0-1.1,0.1-1.6,0.2c-0.5,0.1-0.9,0.4-1.3,0.8c-0.4,0.4-0.8,0.9-1.1,1.6c-0.6,1.6-0.8,3.3-0.8,3.4h4.8
					c0.4,0,0.5,0.2,0.5,0.5l-0.6,3.1c-0.1,0.5-0.5,0.4-0.5,0.4h-5L143.6,98c-0.4,2-0.8,3.7-1.3,5.1c-0.5,1.4-1.1,2.4-2,3.4
					c-0.8,0.9-1.7,1.6-2.8,1.9c-1,0.4-2.3,0.6-3.7,0.6c-0.7,0-1.4,0-2.2-0.2c-0.6-0.1-0.9-0.2-1.4-0.4c-0.2-0.1-0.3-0.3-0.2-0.6
					c0.1-0.3,1-2.7,1.1-3.1c0.2-0.4,0.5-0.2,0.5-0.2c0.3,0.1,0.5,0.2,0.8,0.3c0.4,0.1,0.8,0.1,1.2,0.1c0.7,0,1.3-0.1,1.8-0.3
					c0.6-0.2,1-0.6,1.4-1.1c0.4-0.5,0.7-1.2,1.1-2.1c0.3-0.9,0.6-2.2,0.9-3.7l3.4-18.9h-3.3c-0.4,0-0.5-0.2-0.5-0.5l0.6-3.1
					c0.1-0.5,0.5-0.4,0.5-0.4h3.4l0.2-1c0.5-3,1.5-5.3,3-6.8c1.5-1.5,3.7-2.3,6.4-2.3c0.8,0,1.5,0.1,2.1,0.2
					C155,64.8,155.5,64.9,156,65.1z M88.6,97.6c0,0.3-0.2,0.5-0.4,0.5h-4c-0.3,0-0.4-0.2-0.4-0.5V65.5c0-0.2,0.2-0.5,0.4-0.5h4
					c0.3,0,0.4,0.2,0.4,0.5V97.6z"/>
			</g>
		</g>
	</g>
</g>
</svg>
"]]));
|
|
23
21
|
async function wait(ms = 1000) {
|
|
24
22
|
return new Promise((resolve) => {
|
|
25
23
|
setTimeout(resolve, ms);
|
|
@@ -29,7 +27,9 @@ async function makeRequest(options) {
|
|
|
29
27
|
const rawResponse = await new transport_1.default().httpRequest(options);
|
|
30
28
|
const response = (0, kit_1.parseJsonMap)(rawResponse.body);
|
|
31
29
|
if (response.error) {
|
|
32
|
-
const
|
|
30
|
+
const errorDescription = typeof response.error_description === 'string' ? response.error_description : '';
|
|
31
|
+
const error = typeof response.error === 'string' ? response.error : 'Unknown';
|
|
32
|
+
const err = new sfError_1.SfError(`Request Failed: ${error} ${errorDescription}`);
|
|
33
33
|
err.data = Object.assign(response, { status: rawResponse.statusCode });
|
|
34
34
|
throw err;
|
|
35
35
|
}
|
|
@@ -59,9 +59,9 @@ class DeviceOauthService extends kit_1.AsyncCreatable {
|
|
|
59
59
|
this.pollingCount = 0;
|
|
60
60
|
this.options = options;
|
|
61
61
|
if (!this.options.clientId)
|
|
62
|
-
this.options.clientId =
|
|
62
|
+
this.options.clientId = org_1.DEFAULT_CONNECTED_APP_INFO.clientId;
|
|
63
63
|
if (!this.options.loginUrl)
|
|
64
|
-
this.options.loginUrl =
|
|
64
|
+
this.options.loginUrl = org_1.AuthInfo.getDefaultInstanceUrl();
|
|
65
65
|
}
|
|
66
66
|
/**
|
|
67
67
|
* Begin the authorization flow by requesting the login
|
|
@@ -82,8 +82,7 @@ class DeviceOauthService extends kit_1.AsyncCreatable {
|
|
|
82
82
|
const deviceFlowRequestUrl = this.getDeviceFlowRequestUrl();
|
|
83
83
|
const pollingOptions = this.getPollingOptions(deviceFlowRequestUrl, loginData.device_code);
|
|
84
84
|
const interval = kit_1.Duration.seconds(loginData.interval).milliseconds;
|
|
85
|
-
|
|
86
|
-
return response;
|
|
85
|
+
return this.pollForDeviceApproval(pollingOptions, interval);
|
|
87
86
|
}
|
|
88
87
|
/**
|
|
89
88
|
* Creates and saves new AuthInfo
|
|
@@ -91,7 +90,7 @@ class DeviceOauthService extends kit_1.AsyncCreatable {
|
|
|
91
90
|
* @returns {Promise<AuthInfo>}
|
|
92
91
|
*/
|
|
93
92
|
async authorizeAndSave(approval) {
|
|
94
|
-
const authInfo = await
|
|
93
|
+
const authInfo = await org_1.AuthInfo.create({
|
|
95
94
|
oauth2Options: {
|
|
96
95
|
loginUrl: approval.instance_url,
|
|
97
96
|
refreshToken: approval.refresh_token,
|
|
@@ -108,27 +107,27 @@ class DeviceOauthService extends kit_1.AsyncCreatable {
|
|
|
108
107
|
this.logger.debug(`this.options.loginUrl: ${this.options.loginUrl}`);
|
|
109
108
|
}
|
|
110
109
|
getLoginOptions(url) {
|
|
111
|
-
const
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
110
|
+
const form = new FormData();
|
|
111
|
+
form.append('client_id', (0, ts_types_1.ensureString)(this.options.clientId));
|
|
112
|
+
form.append('response_type', DeviceOauthService.RESPONSE_TYPE);
|
|
113
|
+
form.append('scope', DeviceOauthService.SCOPE);
|
|
115
114
|
return {
|
|
116
115
|
url,
|
|
117
|
-
headers:
|
|
116
|
+
headers: { ...org_1.SFDX_HTTP_HEADERS, ...form.getHeaders() },
|
|
118
117
|
method: 'POST',
|
|
119
|
-
body,
|
|
118
|
+
body: form.getBuffer(),
|
|
120
119
|
};
|
|
121
120
|
}
|
|
122
121
|
getPollingOptions(url, code) {
|
|
123
|
-
const
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
122
|
+
const form = new FormData();
|
|
123
|
+
form.append('client_id', (0, ts_types_1.ensureString)(this.options.clientId));
|
|
124
|
+
form.append('grant_type', DeviceOauthService.GRANT_TYPE);
|
|
125
|
+
form.append('code', code);
|
|
127
126
|
return {
|
|
128
127
|
url,
|
|
129
|
-
headers:
|
|
128
|
+
headers: { ...org_1.SFDX_HTTP_HEADERS, ...form.getHeaders() },
|
|
130
129
|
method: 'POST',
|
|
131
|
-
body,
|
|
130
|
+
body: form.getBuffer(),
|
|
132
131
|
};
|
|
133
132
|
}
|
|
134
133
|
getDeviceFlowRequestUrl() {
|
|
@@ -140,7 +139,7 @@ class DeviceOauthService extends kit_1.AsyncCreatable {
|
|
|
140
139
|
return await makeRequest(httpRequest);
|
|
141
140
|
}
|
|
142
141
|
catch (e) {
|
|
143
|
-
|
|
142
|
+
/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/restrict-template-expressions */
|
|
144
143
|
const err = e.data;
|
|
145
144
|
if (err.error && err.status === 400 && err.error === 'authorization_pending') {
|
|
146
145
|
// do nothing because we're still waiting
|
|
@@ -155,6 +154,7 @@ class DeviceOauthService extends kit_1.AsyncCreatable {
|
|
|
155
154
|
}
|
|
156
155
|
throw err;
|
|
157
156
|
}
|
|
157
|
+
/* eslint-enable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/restrict-template-expressions */
|
|
158
158
|
}
|
|
159
159
|
}
|
|
160
160
|
shouldContinuePolling() {
|
|
@@ -164,6 +164,7 @@ class DeviceOauthService extends kit_1.AsyncCreatable {
|
|
|
164
164
|
this.logger.debug('BEGIN POLLING FOR DEVICE APPROVAL');
|
|
165
165
|
let result;
|
|
166
166
|
while (this.shouldContinuePolling()) {
|
|
167
|
+
// eslint-disable-next-line no-await-in-loop
|
|
167
168
|
result = await this.poll(httpRequest);
|
|
168
169
|
if (result) {
|
|
169
170
|
this.logger.debug('POLLING FOR DEVICE APPROVAL SUCCESS');
|
|
@@ -171,6 +172,7 @@ class DeviceOauthService extends kit_1.AsyncCreatable {
|
|
|
171
172
|
}
|
|
172
173
|
else {
|
|
173
174
|
this.logger.debug(`waiting ${interval} ms...`);
|
|
175
|
+
// eslint-disable-next-line no-await-in-loop
|
|
174
176
|
await wait(interval);
|
|
175
177
|
this.pollingCount += 1;
|
|
176
178
|
}
|
package/lib/exported.d.ts
CHANGED
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
export { OAuth2Config } from 'jsforce';
|
|
2
2
|
export { ConfigFile } from './config/configFile';
|
|
3
|
+
export { TTLConfig } from './config/ttlConfig';
|
|
3
4
|
export { envVars, EnvironmentVariable, SUPPORTED_ENV_VARS, EnvVars } from './config/envVars';
|
|
4
|
-
export {
|
|
5
|
-
export {
|
|
5
|
+
export { ConfigContents, ConfigEntry, ConfigStore, ConfigValue } from './config/configStore';
|
|
6
|
+
export { SfTokens, StateAggregator } from './stateAggregator';
|
|
6
7
|
export { DeviceOauthService, DeviceCodeResponse, DeviceCodePollingResponse } from './deviceOauthService';
|
|
7
8
|
export { OrgUsersConfig } from './config/orgUsersConfig';
|
|
8
|
-
export { ConfigPropertyMeta, ConfigPropertyMetaInput, Config, SfdxPropertyKeys, SFDX_ALLOWED_PROPERTIES, } from './config/config';
|
|
9
|
+
export { ConfigPropertyMeta, ConfigPropertyMetaInput, Config, SfdxPropertyKeys, SfConfigProperties, SFDX_ALLOWED_PROPERTIES, SF_ALLOWED_PROPERTIES, } from './config/config';
|
|
10
|
+
export { SandboxRequestCacheEntry, SandboxRequestCache } from './config/sandboxProcessCache';
|
|
9
11
|
export { ConfigInfo, ConfigAggregator } from './config/configAggregator';
|
|
10
|
-
export { AuthFields, AuthInfo, OrgAuthorization } from './org/authInfo';
|
|
12
|
+
export { AuthFields, AuthInfo, AuthSideEffects, OrgAuthorization } from './org/authInfo';
|
|
11
13
|
export { AuthRemover } from './org/authRemover';
|
|
12
14
|
export { Connection, SFDX_HTTP_HEADERS } from './org/connection';
|
|
13
15
|
export { Mode, Global } from './global';
|
|
@@ -16,20 +18,21 @@ export { WebOAuthServer } from './webOAuthServer';
|
|
|
16
18
|
export { SfdcUrl } from './util/sfdcUrl';
|
|
17
19
|
export { getJwtAudienceUrl } from './util/getJwtAudienceUrl';
|
|
18
20
|
export { Fields, FieldValue, LoggerLevel, LoggerLevelValue, LogLine, LoggerOptions, LoggerStream, Logger, } from './logger';
|
|
19
|
-
export { Messages } from './messages';
|
|
20
|
-
export { Org, SandboxProcessObject, StatusEvent, SandboxEvents, SandboxUserAuthResponse, SandboxUserAuthRequest, SandboxRequest, OrgTypes, ResultEvent, ScratchOrgRequest, } from './org';
|
|
21
|
+
export { Messages, StructuredMessage } from './messages';
|
|
22
|
+
export { Org, SandboxProcessObject, StatusEvent, SandboxEvents, SandboxUserAuthResponse, SandboxUserAuthRequest, SandboxRequest, ResumeSandboxRequest, OrgTypes, ResultEvent, ScratchOrgRequest, } from './org';
|
|
21
23
|
export { OrgConfigProperties, ORG_CONFIG_ALLOWED_PROPERTIES } from './org/orgConfigProperties';
|
|
22
|
-
export { PackageDir, NamedPackageDir, PackageDirDependency,
|
|
23
|
-
export { SchemaPrinter } from './schema/printer';
|
|
24
|
+
export { PackageDir, NamedPackageDir, PackageDirDependency, SfProject, SfProjectJson } from './sfProject';
|
|
24
25
|
export { SchemaValidator } from './schema/validator';
|
|
25
|
-
export {
|
|
26
|
+
export { SchemaPrinter } from './schema/printer';
|
|
27
|
+
export { SfError } from './sfError';
|
|
26
28
|
export { PollingClient } from './status/pollingClient';
|
|
27
29
|
export { CometClient, CometSubscription, StreamingClient, StatusResult } from './status/streamingClient';
|
|
28
30
|
export { MyDomainResolver } from './status/myDomainResolver';
|
|
29
31
|
export { DefaultUserFields, REQUIRED_FIELDS, User, UserFields } from './org/user';
|
|
30
32
|
export { PermissionSetAssignment, PermissionSetAssignmentFields } from './org/permissionSetAssignment';
|
|
31
|
-
export { ScratchOrgCreateOptions, ScratchOrgCreateResult, scratchOrgCreate } from './org/scratchOrgCreate';
|
|
32
|
-
export { ScratchOrgInfo } from './org/
|
|
33
|
-
export
|
|
33
|
+
export { ScratchOrgCreateOptions, ScratchOrgCreateResult, scratchOrgCreate, scratchOrgResume, } from './org/scratchOrgCreate';
|
|
34
|
+
export { ScratchOrgInfo } from './org/scratchOrgTypes';
|
|
35
|
+
export { ScratchOrgLifecycleEvent, scratchOrgLifecycleEventName, scratchOrgLifecycleStages, } from './org/scratchOrgLifecycleEvents';
|
|
36
|
+
export { ScratchOrgCache } from './org/scratchOrgCache';
|
|
34
37
|
export * from './util/sfdc';
|
|
35
38
|
export * from './util/sfdcUrl';
|