homebridge-aeg-robot/dist/logger.js

AEG RX9 / Electrolux Pure i9 robot vacuum plugin for Homebridge

// Homebridge plugin for AEG RX 9 / Electrolux Pure i9 robot vacuum
// Copyright © 2022-2023 Alexander Thoukydides
import { assertIsDefined, formatList, MS } from './utils.js';
import { checkers } from './ti/token-types.js';
// Mapping of applianceId values to their names
const applianceIds = new Map();
const LENGTH = { pnc: 9, sn: 8, ai: 24 };
// Regular expressions for different types of sensitive data
const filters = [
    [maskAPIKey, /\w_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/],
    [maskAccessToken, /\b[\w-]+\.[\w-]+\.[\w-]+\b/g],
    [maskRefreshToken, /(?<="refreshToken":\s*")[^"]+(?=")/gi] // (within JSON)
];
// A logger with filtering and support for an additional prefix
export class PrefixLogger {
    logger;
    prefix;
    // Log level used for debug messages
    debugLevel = "debug" /* LogLevel.DEBUG */;
    // Create a new logger
    constructor(logger, prefix) {
        this.logger = logger;
        this.prefix = prefix;
    }
    // Wrappers around the standard Logger methods
    info(message) { this.log("info" /* LogLevel.INFO */, message); }
    success(message) { this.log("success" /* LogLevel.SUCCESS */, message); }
    warn(message) { this.log("warn" /* LogLevel.WARN */, message); }
    error(message) { this.log("error" /* LogLevel.ERROR */, message); }
    debug(message) { this.log("debug" /* LogLevel.DEBUG */, message); }
    log(level, message) {
        // Allow debug messages to be logged as a different level
        if (level === "debug" /* LogLevel.DEBUG */)
            level = this.debugLevel;
        // Mask any sensitive data within the log message
        message = PrefixLogger.filterSensitive(message);
        // Log each line of the message
        const prefix = this.prefix?.length ? `[${this.prefix}] ` : '';
        message.split('\n').forEach(line => { this.logger.log(level, prefix + line); });
    }
    // Log all DEBUG messages as INFO to avoid being dropped by Homebridge
    logDebugAsInfo() {
        this.debugLevel = "info" /* LogLevel.INFO */;
    }
    // Attempt to filter sensitive data within the log message
    static filterSensitive(message) {
        return filters.reduce((message, [filter, regex]) => message.replace(regex, filter), message);
    }
    // Add an applianceId to filter
    static addApplianceId(applianceId, name) {
        if (applianceIds.has(applianceId))
            return;
        name ??= `SN${applianceIds.size + 1}`;
        const serialNumber = applianceId.slice(LENGTH.pnc, LENGTH.pnc + LENGTH.sn);
        applianceIds.set(applianceId, name);
        filters.push([maskSerialNumber.bind(null, name), new RegExp(`\\b${serialNumber}\\b`, 'g')], [maskApplianceId.bind(null, name), new RegExp(`\\b${applianceId}\\b`, 'g')]);
    }
}
// Mask an Electrolux Group API Key
function maskAPIKey(apiKey) {
    return maskToken('API_KEY', apiKey);
}
// Mask an Electrolux Group API refresh token
function maskRefreshToken(token) {
    return maskToken('REFRESH_TOKEN', token);
}
// Mask a Home Connect access token
function maskAccessToken(token) {
    try {
        const parts = token.split('.').map(part => decodeBase64URL(part));
        assertIsDefined(parts[0]);
        assertIsDefined(parts[1]);
        const header = JSON.parse(parts[0]);
        const payload = JSON.parse(parts[1]);
        if (checkers.AccessTokenHeader.test(header)
            && checkers.AccessTokenPayload.test(payload)) {
            return maskToken('ACCESS_TOKEN', token, {
                issued: new Date(payload.iat * MS).toISOString(),
                expires: new Date(payload.exp * MS).toISOString(),
                scope: payload.scope
            });
        }
        return maskToken('JSON_WEB_TOKEN', token);
    }
    catch {
        return token;
    }
}
// Mask a serial number
function maskSerialNumber(name, _serialNumber) {
    return `<SERIAL_NUMBER: "${name}">`;
}
// Mask an applianceId
function maskApplianceId(name, applianceId) {
    const pnc = applianceId.slice(0, LENGTH.pnc);
    return `<PRODUCT_ID: ${pnc}... "${name}">`;
}
// Mask a token, leaving just the first and final few characters
function maskToken(type, token, details = {}) {
    let masked = `${token.slice(0, 4)}...${token.slice(-8)}`;
    const parts = Object.entries(details).map(([key, value]) => `${key}=${value}`);
    if (parts.length)
        masked += ` (${formatList(parts)})`;
    return `<${type}: ${masked}>`;
}
// Decode a Base64URL encoded string
function decodeBase64URL(base64url) {
    const paddedLength = base64url.length + (4 - base64url.length % 4) % 4;
    const base64 = base64url.replace(/-/g, '+').replace(/_/g, '/').padEnd(paddedLength, '=');
    return Buffer.from(base64, 'base64').toString();
}
//# sourceMappingURL=logger.js.map