@parallax-rn/protocol 0.1.0-beta.2 → 0.1.0-beta.4

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/dist/index.d.ts CHANGED
@@ -11,5 +11,5 @@ export { BUILT_IN_SOURCES, SOURCE_NAME_PATTERN, isSourceName, sourceKind } from
11
11
  export { SDK_API, contractSnapshotText, describeContract, parseCommandCall, parseCommandList, parseCommandResult, parseDrainRequest, parseDrainResult, parseErrorShape, parseHandshake, parseJson, parsePushBatch, parseSourceData, parseSourceTable, sourceDataType, planContractSnapshotUpdate, schemas, } from './contract.js';
12
12
  export type { BufferState, CommandCall, CommandInfo, CommandResult, DrainRequest, DrainResult, ErrorEntry, ErrorShape, Handshake, LogEntry, LogLevel, NavigationEntry, NetworkEntry, ParallaxGlobal, PushBatch, SdkApi, SourceEntry, StateEntry, SourceRow, SourceTable, } from './contract.js';
13
13
  export { isMetroRequest } from './metro-requests.js';
14
- export { NEW_REJECTION, OLD_REJECTION, REDACTED_TEXT, REJECTION_NAME, SECRET_KEY, isSecretKey, keyWords, looksRandom, scrubLine, scrubText, unhandledRejectionOf } from './rules.js';
14
+ export { NEW_REJECTION, OLD_REJECTION, REDACTED_TEXT, REJECTION_NAME, SECRET_KEY, isSecretKey, keyWords, looksRandom, scrubField, scrubLine, scrubText, unhandledRejectionOf } from './rules.js';
15
15
  //# sourceMappingURL=index.d.ts.map
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.unhandledRejectionOf = exports.scrubText = exports.scrubLine = exports.looksRandom = exports.keyWords = exports.isSecretKey = exports.SECRET_KEY = exports.REJECTION_NAME = exports.REDACTED_TEXT = exports.OLD_REJECTION = exports.NEW_REJECTION = exports.isMetroRequest = exports.schemas = exports.planContractSnapshotUpdate = exports.sourceDataType = exports.parseSourceTable = exports.parseSourceData = exports.parsePushBatch = exports.parseJson = exports.parseHandshake = exports.parseErrorShape = exports.parseDrainResult = exports.parseDrainRequest = exports.parseCommandResult = exports.parseCommandList = exports.parseCommandCall = exports.describeContract = exports.contractSnapshotText = exports.SDK_API = exports.sourceKind = exports.isSourceName = exports.SOURCE_NAME_PATTERN = exports.BUILT_IN_SOURCES = exports.registrationSource = exports.parse = exports.isRelativePath = exports.parseInjectedTestId = exports.injectedTestId = exports.INJECTED_ID_PREFIX = exports.isErrorCode = exports.WARNING_CODES = exports.ERROR_CODES = exports.formatProtocol = exports.compareProtocol = exports.PROTOCOL_VERSION = exports.PUSH_BINDING_NAME = exports.GLOBAL_NAME = void 0;
3
+ exports.unhandledRejectionOf = exports.scrubText = exports.scrubLine = exports.scrubField = exports.looksRandom = exports.keyWords = exports.isSecretKey = exports.SECRET_KEY = exports.REJECTION_NAME = exports.REDACTED_TEXT = exports.OLD_REJECTION = exports.NEW_REJECTION = exports.isMetroRequest = exports.schemas = exports.planContractSnapshotUpdate = exports.sourceDataType = exports.parseSourceTable = exports.parseSourceData = exports.parsePushBatch = exports.parseJson = exports.parseHandshake = exports.parseErrorShape = exports.parseDrainResult = exports.parseDrainRequest = exports.parseCommandResult = exports.parseCommandList = exports.parseCommandCall = exports.describeContract = exports.contractSnapshotText = exports.SDK_API = exports.sourceKind = exports.isSourceName = exports.SOURCE_NAME_PATTERN = exports.BUILT_IN_SOURCES = exports.registrationSource = exports.parse = exports.isRelativePath = exports.parseInjectedTestId = exports.injectedTestId = exports.INJECTED_ID_PREFIX = exports.isErrorCode = exports.WARNING_CODES = exports.ERROR_CODES = exports.formatProtocol = exports.compareProtocol = exports.PROTOCOL_VERSION = exports.PUSH_BINDING_NAME = exports.GLOBAL_NAME = void 0;
4
4
  // Public surface of @parallax-rn/protocol: pure data, validators and rules. No dependencies and no side effects
5
5
  // (decision 0007).
6
6
  var names_js_1 = require("./names.js");
@@ -57,6 +57,7 @@ Object.defineProperty(exports, "SECRET_KEY", { enumerable: true, get: function (
57
57
  Object.defineProperty(exports, "isSecretKey", { enumerable: true, get: function () { return rules_js_1.isSecretKey; } });
58
58
  Object.defineProperty(exports, "keyWords", { enumerable: true, get: function () { return rules_js_1.keyWords; } });
59
59
  Object.defineProperty(exports, "looksRandom", { enumerable: true, get: function () { return rules_js_1.looksRandom; } });
60
+ Object.defineProperty(exports, "scrubField", { enumerable: true, get: function () { return rules_js_1.scrubField; } });
60
61
  Object.defineProperty(exports, "scrubLine", { enumerable: true, get: function () { return rules_js_1.scrubLine; } });
61
62
  Object.defineProperty(exports, "scrubText", { enumerable: true, get: function () { return rules_js_1.scrubText; } });
62
63
  Object.defineProperty(exports, "unhandledRejectionOf", { enumerable: true, get: function () { return rules_js_1.unhandledRejectionOf; } });
package/dist/rules.d.ts CHANGED
@@ -21,6 +21,12 @@ export declare function scrubText(text: string): string;
21
21
  * and lower case.
22
22
  */
23
23
  export declare function scrubLine(text: string): string;
24
+ /**
25
+ * The scrub for an approval card's one field (a file path or a command): `scrubText`, except that a run with `/` and no `+` or `=` (a path) is judged part by part, so
26
+ * `<home>/ParallaxFixtures/fx-e086/src/CompatScreen.tsx` stays readable. Stricter than `scrubLine`: a part goes at 20 characters of digits, upper and lower case, and a run
27
+ * without `/` goes whole, as in `scrubText`.
28
+ */
29
+ export declare function scrubField(text: string): string;
24
30
  export declare const REJECTION_NAME = "UnhandledPromiseRejection";
25
31
  export declare const NEW_REJECTION: RegExp;
26
32
  export declare const OLD_REJECTION: RegExp;
package/dist/rules.js CHANGED
@@ -6,6 +6,7 @@ exports.isSecretKey = isSecretKey;
6
6
  exports.looksRandom = looksRandom;
7
7
  exports.scrubText = scrubText;
8
8
  exports.scrubLine = scrubLine;
9
+ exports.scrubField = scrubField;
9
10
  exports.unhandledRejectionOf = unhandledRejectionOf;
10
11
  /** What replaces a secret value in structured data and free text. */
11
12
  exports.REDACTED_TEXT = '[redacted]';
@@ -52,7 +53,7 @@ function looksRandom(value) {
52
53
  const TEXT_RULES = [
53
54
  [/\b(bearer|basic)\s+[A-Za-z0-9._~+/=-]{6,}/gi, `$1 ${exports.REDACTED_TEXT}`],
54
55
  [/\b([A-Za-z0-9_-]*(?:token|key|secret|password|passwd|pwd)[A-Za-z0-9_-]*)(\s*[=:]\s*)("[^"]*"|'[^']*'|\S+)/gi, `$1$2${exports.REDACTED_TEXT}`],
55
- [/[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+(?:\.[A-Za-z0-9-]+)+/g, exports.REDACTED_TEXT],
56
+ [/[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+(?:\.[A-Za-z0-9-]+)*\.[A-Za-z]{2,}/g, exports.REDACTED_TEXT], // the last label has letters: `pkg@3.16.1` is a version
56
57
  [/\b[0-9a-fA-F]{32,}\b/g, exports.REDACTED_TEXT],
57
58
  ];
58
59
  const LONG_RUN = /[A-Za-z0-9+/_-]{40,}={0,2}/g;
@@ -79,6 +80,51 @@ function scrubLine(text) {
79
80
  }
80
81
  return out.replace(LONG_RUN, secretRun);
81
82
  }
83
+ /**
84
+ * The scrub for an approval card's one field (a file path or a command): `scrubText`, except that a run with `/` and no `+` or `=` (a path) is judged part by part, so
85
+ * `<home>/ParallaxFixtures/fx-e086/src/CompatScreen.tsx` stays readable. Stricter than `scrubLine`: a part goes at 20 characters of digits, upper and lower case, and a run
86
+ * without `/` goes whole, as in `scrubText`.
87
+ */
88
+ function scrubField(text) {
89
+ let out = text;
90
+ for (let i = 0; i < TEXT_RULES.length; i++) {
91
+ const rule = TEXT_RULES[i];
92
+ out = out.replace(rule[0], rule[1]);
93
+ }
94
+ out = out.replace(TOKEN_PREFIX, exports.REDACTED_TEXT).replace(URL_RUN, urlRun).replace(HEX_JOINED, hexJoined);
95
+ return out.replace(LONG_RUN, fieldRun).replace(MIXED_PART, exports.REDACTED_TEXT).replace(BARE_TOKEN, bareToken);
96
+ }
97
+ // The card's extra rules (a path stays readable, a credential does not): a known token prefix anywhere; a URL's secret-looking parts; hex joined by `_` or `-`; a part of 20 or more letters and
98
+ // digits that is not a file name; and a slash-joined run that is not a path (the shape of an AWS secret key).
99
+ const TOKEN_PREFIX = /(?<![A-Za-z0-9])(?:(?:gh[pousr])_[A-Za-z0-9]{16,}|github_pat_\w{16,}|xox[abpsr]-[A-Za-z0-9-]{8,}|sk_(?:live|test)_[A-Za-z0-9]{8,}|sk-[A-Za-z0-9_-]{20,}|AKIA[0-9A-Z]{12,}|AIza[\w-]{20,}|glpat-[\w-]{16,})/g;
100
+ const URL_RUN = /[A-Za-z][A-Za-z0-9+.-]*:\/\/[^\s'"`]+/g;
101
+ const HEX_JOINED = /(?<![0-9A-Za-z])[0-9a-fA-F]+(?:[_-][0-9a-fA-F]+)*(?![0-9A-Za-z])/g;
102
+ const MIXED_PART = /(?<![A-Za-z0-9])(?=[A-Za-z0-9]*\d)(?=[A-Za-z0-9]*[A-Za-z])[A-Za-z0-9]{20,}(?![A-Za-z0-9])(?!\.[A-Za-z][A-Za-z0-9]{0,4}(?![A-Za-z0-9]))/g;
103
+ const BARE_TOKEN = /[^\s'"`]+/g;
104
+ const hasExtension = (part) => /\.[A-Za-z0-9]{1,6}$/.test(part);
105
+ const urlRun = (url) => {
106
+ const at = url.indexOf('://') + 3;
107
+ const parts = url.slice(at).split('/'); // the first part is the host
108
+ let after = false; // everything after /services/ or /hooks/ is a secret
109
+ return url.slice(0, at) + parts.map((part, i) => {
110
+ const secret = i > 0 && (after || (part.length >= 20 && /\d/.test(part) && !hasExtension(part)));
111
+ if (i > 0 && (part === 'services' || part === 'hooks'))
112
+ after = true;
113
+ return secret ? exports.REDACTED_TEXT : part;
114
+ }).join('/');
115
+ };
116
+ const hexJoined = (run) => (run.replace(/[_-]/g, '').length >= 24 && /\d/.test(run) ? exports.REDACTED_TEXT : run);
117
+ const bareToken = (token) => {
118
+ if (token.startsWith('/') || token.startsWith('~/') || token.startsWith('./') || token.startsWith('../') || token.includes('://'))
119
+ return token;
120
+ const parts = token.split('/');
121
+ return parts.length >= 3 && token.length >= 20 && !parts.some(hasExtension) && /\d|[a-z][A-Z]/.test(token) ? exports.REDACTED_TEXT : token;
122
+ };
123
+ const fieldRun = (run) => {
124
+ if (/[+=]/.test(run) || !run.includes('/'))
125
+ return exports.REDACTED_TEXT;
126
+ return run.split('/').map(part => (part.length >= 20 && /\d/.test(part) && /[a-z]/.test(part) && /[A-Z]/.test(part) ? exports.REDACTED_TEXT : part)).join('/');
127
+ };
82
128
  const secretRun = (run) => {
83
129
  if (/[+=]/.test(run))
84
130
  return exports.REDACTED_TEXT;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@parallax-rn/protocol",
3
- "version": "0.1.0-beta.2",
3
+ "version": "0.1.0-beta.4",
4
4
  "description": "Shared contract for Parallax for React Native: wire shapes, validators, error codes, global names and protocol version rules. Tested on React Native 0.87.1 (no dependencies).",
5
5
  "license": "SEE LICENSE IN LICENSE",
6
6
  "main": "dist/index.js",