Skip to content

feat: add grafana faro instrumentation #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add grafana faro instrumentation #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5,329 changes: 5,329 additions & 0 deletions auth/grafana-faro-web-sdk.js
View file
Open in desktop

Large diffs are not rendered by default.

4,248 changes: 4,248 additions & 0 deletions auth/grafana-faro-web-tracing.js
View file
Open in desktop

Large diffs are not rendered by default.

162 changes: 104 additions & 58 deletions auth/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,33 @@
display: none;
}
</style>
<script type="module">
import GrafanaFaroWebSdk from "./grafana-faro-web-sdk.js";
import GrafanaFaroWebTracing from "./grafana-faro-web-tracing.js";

// set environment based on the host
let environment = "development";
const host = window.location.host;
if (host === "auth.turnkey.com") {
environment = "production";
} else if (host === "auth.preprod.turnkey.engineering") {
environment = "preprod";
}

const faro = GrafanaFaroWebSdk.initializeFaro({
url: "https://faro-collector-prod-us-central-0.grafana.net/collect/208ef3024d71da6062bd867dbd1f8b34",
app: {
name: "email-auth",
version: "1.0.0",
environment: environment,
},
trackGeolocation: false,
});

const grafanaTracing = GrafanaFaroWebTracing({}, GrafanaFaroWebSdk);

faro.instrumentations.add(new grafanaTracing.TracingInstrumentation());
</script>
</head>

<body>
Expand Down Expand Up @@ -292,7 +319,9 @@ <h2>Message log</h2>
hexString.length % 2 != 0 ||
!hexRegex.test(hexString)
) {
throw new Error("cannot create uint8array from invalid hex string");
const errorMessage = `cannot create uint8array from invalid hex string: ${hexString}`;
reportError(errorMessage);
throw new Error(errorMessage);
}
var buffer = new Uint8Array(
hexString.match(/../g).map((h) => parseInt(h, 16))
Expand Down Expand Up @@ -365,9 +394,9 @@ <h2>Message log</h2>
*/
async function base58checkDecode(s) {
if (s.length < 5) {
throw new Error(
`cannot base58-decode a string of length < 5 (found length ${s.length})`
);
const errorMessage = `cannot base58-decode a string of length < 5 (found length ${s.length})`;
reportError(errorMessage);
throw new Error(errorMessage);
}

// See https://en.bitcoin.it/wiki/Base58Check_encoding
Expand All @@ -378,9 +407,9 @@ <h2>Message log</h2>
var leadingZeros = [];
for (var i = 0; i < s.length; i++) {
if (alphabet.indexOf(s[i]) === -1) {
throw new Error(
`cannot base58-decode: ${s[i]} isn't a valid character`
);
const errorMessage = `cannot base58-decode: ${s[i]} isn't a valid character`;
reportError(errorMessage);
throw new Error(errorMessage);
}
var carry = alphabet.indexOf(s[i]);

Expand Down Expand Up @@ -430,9 +459,9 @@ <h2>Message log</h2>
);

if (computedChecksum.toString() != foundChecksum.toString()) {
throw new Error(
`unable to decode credential bundle. checksums do not match: computed ${computedChecksum} but found ${foundChecksum}`
);
const errorMessage = `unable to decode credential bundle. checksums do not match: computed ${computedChecksum} but found ${foundChecksum}`;
reportError(errorMessage);
throw new Error(errorMessage);
}

return new Uint8Array(msg);
Expand All @@ -454,9 +483,9 @@ <h2>Message log</h2>
*/
function convertEcdsaIeee1363ToDer(ieee) {
if (ieee.length % 2 != 0 || ieee.length == 0 || ieee.length > 132) {
throw new Error(
"Invalid IEEE P1363 signature encoding. Length: " + ieee.length
);
const errorMessage = `Invalid IEEE P1363 signature encoding. Length: ${ieee.length}`;
reportError(errorMessage);
throw new Error(errorMessage);
}
const r = toUnsignedBigNum(ieee.subarray(0, ieee.length / 2));
const s = toUnsignedBigNum(
Expand Down Expand Up @@ -542,6 +571,15 @@ <h2>Message log</h2>
* @param requestId serves as an idempotency key to match incoming requests. Backwards compatible: if not provided, it isn't passed in.
*/
var sendMessageUp = function (type, value, requestId) {
if (type === "ERROR") {
window.faro?.api?.pushError([value], {
context: {
requestId: requestId,
},
level: "error",
});
}

const message = {
type: type,
value: value,
Expand Down Expand Up @@ -576,6 +614,15 @@ <h2>Message log</h2>
messageLog.appendChild(message);
};

/**
* Function to report errors to Grafana Faro.
*/
var reportError = function (errorMessage) {
window.faro?.api?.pushError([errorMessage], {
level: "error",
});
};

/**
* Convert a JSON Web Key private key to a public key and export the public
* key in raw format.
Expand Down Expand Up @@ -658,9 +705,9 @@ <h2>Message log</h2>
var bigIntToHex = function (num, length) {
var hexString = num.toString(16);
if (hexString.length > length) {
throw new Error(
"number cannot fit in a hex string of " + length + " characters"
);
const errorMessage = `number cannot fit in a hex string of ${length} characters`;
reportError(errorMessage);
throw new Error(errorMessage);
}
// Add an extra 0 to the start of the string to get to `length`
return hexString.padStart(length, 0);
Expand Down Expand Up @@ -717,11 +764,15 @@ <h2>Message log</h2>
}

if (x < BigInt(0) || x >= p) {
throw new Error("x is out of range");
const errorMessage = "x is out of range";
reportError(errorMessage);
throw new Error(errorMessage);
}

if (y < BigInt(0) || y >= p) {
throw new Error("y is out of range");
const errorMessage = "y is out of range";
reportError(errorMessage);
throw new Error(errorMessage);
}

var uncompressedHexString =
Expand All @@ -734,7 +785,9 @@ <h2>Message log</h2>
*/
function modSqrt(x, p) {
if (p <= BigInt(0)) {
throw new Error("p must be positive");
const errorMessage = "p must be positive";
reportError(errorMessage);
throw new Error(errorMessage);
}
const base = x % p;
// The currently supported NIST curves P-256, P-384, and P-521 all satisfy
Expand All @@ -746,12 +799,16 @@ <h2>Message log</h2>
const q = (p + BigInt(1)) >> BigInt(2);
const squareRoot = modPow(base, q, p);
if ((squareRoot * squareRoot) % p !== base) {
throw new Error("could not find a modular square root");
const errorMessage = "could not find a modular square root";
reportError(errorMessage);
throw new Error(errorMessage);
}
return squareRoot;
}
// Skipping other elliptic curve types that require Cipolla's algorithm.
throw new Error("unsupported modulus value");
const errorMessage = `unsupported modulus value: ${p}`;
reportError(errorMessage);
throw new Error(errorMessage);
}

/**
Expand Down Expand Up @@ -823,10 +880,9 @@ <h2>Message log</h2>
} else if (other instanceof P256FieldElement) {
coefficient = other.num;
} else {
throw new Error(
"Cannot multiply element. Expected a BigInt, a Number or a P256FieldElement. Got: " +
other
);
const errorMessage = `Cannot multiply element. Expected a BigInt, a Number or a P256FieldElement. Got: ${other}`;
reportError(errorMessage);
throw new Error(errorMessage);
}
num = (this.num * coefficient) % this.prime;
return new P256FieldElement(num);
Expand Down Expand Up @@ -864,12 +920,16 @@ <h2>Message log</h2>
*/
P256Point = function (x, y) {
if (!x instanceof P256FieldElement) {
throw new Error("expected a P256FieldElement for x. Got: " + x);
const errorMessage = `expected a P256FieldElement for x. Got: ${x}`;
reportError(errorMessage);
throw new Error(errorMessage);
}
this.x = x;

if (!y instanceof P256FieldElement) {
throw new Error("expected a P256FieldElement for y. Got: " + y);
const errorMessage = `expected a P256FieldElement for y. Got: ${y}`;
reportError(errorMessage);
throw new Error(errorMessage);
}
this.y = y;
this.a = new P256FieldElement(
Expand All @@ -893,13 +953,9 @@ <h2>Message log</h2>

if (left != right) {
// y**2 = x**3 + 7 is the elliptic curve equation
throw new Error(
"Not on the P256 curve! y**2 (" +
left +
") != x3 + ax + b (" +
right +
")"
);
const errorMessage = `Not on the P256 curve! y**2 (${left}) != x3 + ax + b (${right})`;
reportError(errorMessage);
throw new Error(errorMessage);
}
};

Expand Down Expand Up @@ -963,18 +1019,9 @@ <h2>Message log</h2>
y = s.mul(this.x.sub(x)).sub(this.y);
return new P256Point(x, y);
}

throw new Error(
"cannot handle addition of (" +
this.x +
", " +
this.y +
") with (" +
other.x +
", " +
other.y +
")"
);
const errorMessage = `cannot handle addition of (${this.x}, ${this.y}) with (${other.x}, ${other.y})`;
reportError(errorMessage);
throw new Error(errorMessage);
};
/**
* Multiplication uses addition. Nothing crazy here.
Expand Down Expand Up @@ -1035,6 +1082,7 @@ <h2>Message log</h2>
sendMessageUp,
setParentFrameMessageChannelPort,
logMessage,
reportError,
base64urlEncode,
base64urlDecode,
base58checkDecode,
Expand Down Expand Up @@ -1264,11 +1312,9 @@ <h2>Message log</h2>
}

if (bundleBytes.byteLength <= 33) {
throw new Error(
"bundle size " +
bundleBytes.byteLength +
" is too low. Expecting a compressed public key (33 bytes) and an encrypted credential"
);
const errorMessage = `bundle size ${bundleBytes.byteLength} is too low. Expecting a compressed public key (33 bytes) and an encrypted credential`;
TKHQ.reportError(errorMessage);
throw new Error(errorMessage);
}

var compressedEncappedKeyBuf = bundleBytes.subarray(0, 33);
Expand Down Expand Up @@ -1339,9 +1385,10 @@ <h2>Message log</h2>
*/
var onStampRequest = async function (payload, requestId) {
if (CREDENTIAL_BYTES === null) {
throw new Error(
"cannot sign payload without credential. Credential bytes are null. Has a credential bundle been injected into the iframe?"
);
const errorMessage =
"cannot sign payload without credential. Credential bytes are null. Has a credential bundle been injected into the iframe?";
TKHQ.reportError(errorMessage);
throw new Error(errorMessage);
}
var key = await TKHQ.importCredential(CREDENTIAL_BYTES);
var signatureIeee1363 = await window.crypto.subtle.sign(
Expand Down Expand Up @@ -1413,10 +1460,9 @@ <h2>Message log</h2>
try {
res = await recipientCtx.open(ciphertextBuf, aad);
} catch (e) {
throw new Error(
"unable to decrypt bundle using embedded key. the bundle may be incorrect. failed with error: " +
e.toString()
);
const errorMessage = `unable to decrypt bundle using embedded key. the bundle may be incorrect. failed with error: ${e.toString()}`;
TKHQ.reportError(errorMessage);
throw new Error(errorMessage);
}
return res;
};
Expand Down
Loading
Loading