discord-sb.js 1.0.0

package/src/util/RemoteAuth.js

@@ -0,0 +1,415 @@
+'use strict';
+
+const { Buffer } = require('node:buffer');
+const crypto = require('node:crypto');
+const EventEmitter = require('node:events');
+const { setTimeout } = require('node:timers');
+const { fetch } = require('undici');
+const { UserAgent } = require('./Constants');
+const Options = require('./Options');
+const { WebSocket } = require('../WebSocket');
+
+const defaultClientOptions = Options.createDefault();
+const superPropertiesBase64 = Buffer.from(JSON.stringify(defaultClientOptions.ws.properties), 'ascii').toString(
+  'base64',
+);
+
+const baseURL = 'https://discord.com/ra/';
+
+const wsURL = 'wss://remote-auth-gateway.discord.gg/?v=2';
+
+const receiveEvent = {
+  HELLO: 'hello',
+  NONCE_PROOF: 'nonce_proof',
+  PENDING_REMOTE_INIT: 'pending_remote_init',
+  HEARTBEAT_ACK: 'heartbeat_ack',
+  PENDING_TICKET: 'pending_ticket',
+  CANCEL: 'cancel',
+  PENDING_LOGIN: 'pending_login',
+};
+
+const sendEvent = {
+  INIT: 'init',
+  NONCE_PROOF: 'nonce_proof',
+  HEARTBEAT: 'heartbeat',
+};
+
+const Event = {
+  READY: 'ready',
+  ERROR: 'error',
+  CANCEL: 'cancel',
+  WAIT_SCAN: 'pending',
+  FINISH: 'finish',
+  CLOSED: 'closed',
+  DEBUG: 'debug',
+};
+
+/**
+ * Discord Auth QR
+ * @extends {EventEmitter}
+ * @abstract
+ */
+class DiscordAuthWebsocket extends EventEmitter {
+  #ws = null;
+  #heartbeatTimeout = null;
+  #heartbeatInterval = null;
+  #expire = null;
+  #publicKey = null;
+  #privateKey = null;
+  #encodedPublicKey = null;
+  #ticket = null;
+  #fingerprint = '';
+  #userDecryptString = '';
+
+  /**
+   * Creates a new DiscordAuthWebsocket instance.
+   */
+  constructor() {
+    super();
+    this.token = '';
+  }
+
+  /**
+   * @type {string}
+   */
+  get AuthURL() {
+    return baseURL + this.#fingerprint;
+  }
+
+  /**
+   * @type {Date}
+   */
+  get exprire() {
+    return this.#expire;
+  }
+
+  /**
+   * @type {UserRaw}
+   */
+  get user() {
+    return DiscordAuthWebsocket.decryptUser(this.#userDecryptString);
+  }
+
+  #createWebSocket(url) {
+    this.#ws = new WebSocket(url, {
+      headers: {
+        Origin: 'https://discord.com',
+        'User-Agent': UserAgent,
+      },
+    });
+    this.#handleWebSocket();
+  }
+
+  #clearHeartbeatTimer() {
+    if (!this.#heartbeatTimeout) return;
+    clearTimeout(this.#heartbeatTimeout);
+    this.#heartbeatTimeout = null;
+  }
+
+  #parseMessage(message) {
+    try {
+      const payload =
+        typeof message === 'string'
+          ? message
+          : Buffer.isBuffer(message)
+          ? message.toString('utf8')
+          : message?.data instanceof ArrayBuffer
+          ? Buffer.from(message.data).toString('utf8')
+          : Buffer.isBuffer(message?.data)
+          ? message.data.toString('utf8')
+          : message?.data ?? message;
+      const serialized = typeof payload === 'string' ? payload : String(payload);
+      return JSON.parse(serialized);
+    } catch (error) {
+      this.emit(Event.ERROR, error);
+      return null;
+    }
+  }
+
+  #handleWebSocket() {
+    this.#ws.on('error', error => {
+      /**
+       * WS Error
+       * @event DiscordAuthWebsocket#error
+       * @param {Error} error Error
+       */
+      this.emit(Event.ERROR, error);
+    });
+    this.#ws.on('open', () => {
+      /**
+       * Debug Event
+       * @event DiscordAuthWebsocket#debug
+       * @param {string} msg Debug msg
+       */
+      this.emit(Event.DEBUG, '[WS] Client Connected');
+    });
+    this.#ws.on('close', () => {
+      this.#clearHeartbeatTimer();
+      this.emit(Event.DEBUG, '[WS] Connection closed');
+    });
+    this.#ws.on('message', this.#handleMessage.bind(this));
+  }
+
+  #handleMessage(message) {
+    const payload = this.#parseMessage(message);
+    if (!payload) return;
+    switch (payload.op) {
+      case receiveEvent.HELLO: {
+        this.#ready(payload);
+        break;
+      }
+
+      case receiveEvent.NONCE_PROOF: {
+        this.#receiveNonceProof(payload);
+        break;
+      }
+
+      case receiveEvent.PENDING_REMOTE_INIT: {
+        this.#fingerprint = payload.fingerprint;
+        /**
+         * Ready Event
+         * @event DiscordAuthWebsocket#ready
+         * @param {DiscordAuthWebsocket} client WS
+         */
+        this.emit(Event.READY, this);
+        break;
+      }
+
+      case receiveEvent.HEARTBEAT_ACK: {
+        this.emit(Event.DEBUG, `Heartbeat acknowledged.`);
+        this.#heartbeatAck();
+        break;
+      }
+
+      case receiveEvent.PENDING_TICKET: {
+        this.#pendingLogin(payload);
+        break;
+      }
+
+      case receiveEvent.CANCEL: {
+        /**
+         * Cancel
+         * @event DiscordAuthWebsocket#cancel
+         * @param {DiscordAuthWebsocket} client WS
+         */
+        this.emit(Event.CANCEL, this);
+        this.destroy();
+        break;
+      }
+
+      case receiveEvent.PENDING_LOGIN: {
+        this.#ticket = payload.ticket;
+        this.#findRealToken();
+        break;
+      }
+    }
+  }
+
+  #send(op, data) {
+    if (!this.#ws || this.#ws.readyState !== WebSocket.OPEN) return;
+    let payload = { op: op };
+    if (data !== null) payload = { ...payload, ...data };
+    this.#ws.send(JSON.stringify(payload));
+  }
+
+  #heartbeatAck() {
+    this.#clearHeartbeatTimer();
+    this.#heartbeatTimeout = setTimeout(() => {
+      this.#send(sendEvent.HEARTBEAT);
+    }, this.#heartbeatInterval);
+    if (typeof this.#heartbeatTimeout.unref === 'function') {
+      this.#heartbeatTimeout.unref();
+    }
+  }
+
+  #ready(data) {
+    this.emit(Event.DEBUG, 'Attempting server handshake...');
+    this.#expire = new Date(Date.now() + data.timeout_ms);
+    this.#heartbeatInterval = data.heartbeat_interval;
+    this.#createKey();
+    this.#heartbeatAck();
+    this.#init();
+  }
+
+  #createKey() {
+    const key = crypto.generateKeyPairSync('rsa', {
+      modulusLength: 2048,
+      publicKeyEncoding: {
+        type: 'spki',
+        format: 'pem',
+      },
+      privateKeyEncoding: {
+        type: 'pkcs1',
+        format: 'pem',
+      },
+    });
+    this.#privateKey = typeof key.privateKey === 'string' ? key.privateKey : key.privateKey.toString('utf8');
+    this.#publicKey = typeof key.publicKey === 'string' ? key.publicKey : key.publicKey.toString('utf8');
+    this.#encodedPublicKey = this.#encodePublicKey();
+  }
+
+  #encodePublicKey() {
+    return this.#publicKey
+      .replace('-----BEGIN PUBLIC KEY-----\n', '')
+      .replace('\n-----END PUBLIC KEY-----\n', '')
+      .replace(/\n/g, '');
+  }
+
+  #init() {
+    this.#send(sendEvent.INIT, { encoded_public_key: this.#encodedPublicKey });
+  }
+
+  #receiveNonceProof(data) {
+    const nonce = data.encrypted_nonce;
+    const decrypted_nonce = this.#decryptPayload(nonce);
+    const proof = crypto.createHash('sha256').update(decrypted_nonce).digest('base64url');
+    this.#send(sendEvent.NONCE_PROOF, { proof: proof });
+  }
+
+  #decryptPayload(encrypted_payload) {
+    const payload = Buffer.from(encrypted_payload, 'base64');
+    const data = crypto.privateDecrypt(
+      {
+        key: this.#privateKey,
+        padding: crypto.constants.RSA_PKCS1_OAEP_PADDING,
+        oaepHash: 'sha256',
+      },
+      payload,
+    );
+    return data;
+  }
+
+  #pendingLogin(data) {
+    const user_data = this.#decryptPayload(data.encrypted_user_payload);
+    this.#userDecryptString = user_data.toString('utf8');
+
+    /**
+     * @typedef {Object} UserRaw
+     * @property {Snowflake} id
+     * @property {string} username
+     * @property {number} discriminator
+     * @property {string} avatar
+     */
+
+    /**
+     * Emitted whenever a user is scan QR Code.
+     * @event DiscordAuthWebsocket#pending
+     * @param {UserRaw} user Discord User Raw
+     */
+    this.emit(Event.WAIT_SCAN, this.user);
+  }
+
+  #awaitLogin(client) {
+    return new Promise(r => {
+      this.once(Event.FINISH, token => {
+        r(client.login(token));
+      });
+    });
+  }
+
+  /**
+   * Connect WS
+   * @param {Client} [client] DiscordJS Client
+   * @returns {Promise<void>}
+   */
+  connect(client) {
+    this.#createWebSocket(wsURL);
+    if (client) {
+      return this.#awaitLogin(client);
+    } else {
+      return Promise.resolve();
+    }
+  }
+
+  /**
+   * Destroy client
+   * @returns {void}
+   */
+  destroy() {
+    if (!this.#ws) return;
+    this.#clearHeartbeatTimer();
+    this.#ws.close();
+    this.#ws = null;
+    this.emit(Event.DEBUG, 'WebSocket closed.');
+    /**
+     * Emitted whenever a connection is closed.
+     * @event DiscordAuthWebsocket#closed
+     */
+    this.emit(Event.CLOSED);
+  }
+
+  /**
+   * Generate QR code for user to scan (Terminal)
+   * @returns {void}
+   */
+  generateQR() {
+    if (!this.#fingerprint) return;
+    require('qrcode').toString(this.AuthURL, { type: 'utf8', errorCorrectionLevel: 'L' }, (err, url) => {
+      if (err) {
+        //
+      }
+      console.log(url);
+    });
+  }
+
+  async #findRealToken() {
+    try {
+      const response = await fetch(`https://discord.com/api/v9/users/@me/remote-auth/login`, {
+        method: 'POST',
+        headers: {
+          Accept: '*/*',
+          'Accept-Language': 'en-US',
+          'Content-Type': 'application/json',
+          'Sec-Fetch-Dest': 'empty',
+          'Sec-Fetch-Mode': 'cors',
+          'Sec-Fetch-Site': 'same-origin',
+          'X-Debug-Options': 'bugReporterEnabled',
+          'X-Super-Properties': superPropertiesBase64,
+          'X-Discord-Locale': 'en-US',
+          'User-Agent': UserAgent,
+          Referer: 'https://discord.com/channels/@me',
+          Connection: 'keep-alive',
+          Origin: 'https://discord.com',
+        },
+        body: JSON.stringify({
+          ticket: this.#ticket,
+        }),
+      });
+
+      if (!response.ok) {
+        throw new Error(`Remote auth exchange failed with status ${response.status}`);
+      }
+
+      const res = await response.json();
+      if (res.encrypted_token) {
+        this.token = this.#decryptPayload(res.encrypted_token).toString('utf8');
+      }
+      /**
+       * Emitted whenever a real token is found.
+       * @event DiscordAuthWebsocket#finish
+       * @param {string} token Discord Token
+       */
+      this.emit(Event.FINISH, this.token);
+    } catch (error) {
+      this.emit(Event.ERROR, error);
+    } finally {
+      this.destroy();
+    }
+  }
+
+  static decryptUser(payload) {
+    const values = payload.split(':');
+    const id = values[0];
+    const username = values[3];
+    const discriminator = values[1];
+    const avatar = values[2];
+    return {
+      id,
+      username,
+      discriminator,
+      avatar,
+    };
+  }
+}
+
+module.exports = DiscordAuthWebsocket;

package/src/util/RoleFlags.js

@@ -0,0 +1,37 @@
+'use strict';
+
+const BitField = require('./BitField');
+
+/**
+ * Data structure that makes it easy to interact with an {@link GuildMember#flags} bitfield.
+ * @extends {BitField}
+ */
+class RoleFlags extends BitField {}
+
+/**
+ * @name RoleFlags
+ * @kind constructor
+ * @memberof RoleFlags
+ * @param {BitFieldResolvable} [bits=0] Bit(s) to read from
+ */
+
+/**
+ * Numeric guild member flags. All available properties:
+ * * `IN_PROMPT`
+ * @type {Object}
+ * @see {@link https://discord.com/developers/docs/topics/permissions#role-object-role-flags}
+ */
+RoleFlags.FLAGS = {
+  IN_PROMPT: 1 << 0,
+};
+
+/**
+ * Data that can be resolved to give a role flag bitfield. This can be:
+ * * A string (see {@link RoleFlags.FLAGS})
+ * * A role flag
+ * * An instance of RoleFlags
+ * * An Array of RoleFlagsResolvable
+ * @typedef {string|number|RoleFlags|RoleFlagsResolvable[]} RoleFlagsResolvable
+ */
+
+module.exports = RoleFlags;

package/src/util/SnowflakeUtil.js

@@ -0,0 +1,92 @@
+'use strict';
+
+// Discord epoch (2015-01-01T00:00:00.000Z)
+const EPOCH = 1_420_070_400_000;
+let INCREMENT = BigInt(0);
+
+/**
+ * A container for useful snowflake-related methods.
+ */
+class SnowflakeUtil extends null {
+  /**
+   * A {@link https://docs.x.com/resources/fundamentals/x-ids Twitter snowflake},
+   * except the epoch is 2015-01-01T00:00:00.000Z.
+   *
+   * If we have a snowflake '266241948824764416' we can represent it as binary:
+   * ```
+   * 64                                          22     17     12          0
+   *  000000111011000111100001101001000101000000  00001  00000  000000000000
+   *  number of milliseconds since Discord epoch  worker  pid    increment
+   * ```
+   * @typedef {string} Snowflake
+   */
+
+  /**
+   * Generates a Discord snowflake.
+   * <info>This hardcodes the worker's id as 1 and the process's id as 0.</info>
+   * @param {number|Date} [timestamp=Date.now()] Timestamp or date of the snowflake to generate
+   * @returns {Snowflake} The generated snowflake
+   */
+  static generate(timestamp = Date.now()) {
+    if (timestamp instanceof Date) timestamp = timestamp.getTime();
+    if (typeof timestamp !== 'number' || isNaN(timestamp)) {
+      throw new TypeError(
+        `"timestamp" argument must be a number (received ${isNaN(timestamp) ? 'NaN' : typeof timestamp})`,
+      );
+    }
+    if (INCREMENT >= 4095n) INCREMENT = BigInt(0);
+
+    // Assign WorkerId as 1 and ProcessId as 0:
+    return ((BigInt(timestamp - EPOCH) << 22n) | (1n << 17n) | INCREMENT++).toString();
+  }
+
+  /**
+   * A deconstructed snowflake.
+   * @typedef {Object} DeconstructedSnowflake
+   * @property {number} timestamp Timestamp the snowflake was created
+   * @property {Date} date Date the snowflake was created
+   * @property {number} workerId The worker's id in the snowflake
+   * @property {number} processId The process's id in the snowflake
+   * @property {number} increment Increment in the snowflake
+   * @property {string} binary Binary representation of the snowflake
+   */
+
+  /**
+   * Deconstructs a Discord snowflake.
+   * @param {Snowflake} snowflake Snowflake to deconstruct
+   * @returns {DeconstructedSnowflake}
+   */
+  static deconstruct(snowflake) {
+    const bigIntSnowflake = BigInt(snowflake);
+    return {
+      timestamp: Number(bigIntSnowflake >> 22n) + EPOCH,
+      get date() {
+        return new Date(this.timestamp);
+      },
+      workerId: Number((bigIntSnowflake >> 17n) & 0b11111n),
+      processId: Number((bigIntSnowflake >> 12n) & 0b11111n),
+      increment: Number(bigIntSnowflake & 0b111111111111n),
+      binary: bigIntSnowflake.toString(2).padStart(64, '0'),
+    };
+  }
+
+  /**
+   * Retrieves the timestamp field's value from a Discord snowflake.
+   * @param {Snowflake} snowflake Snowflake to get the timestamp value from
+   * @returns {number}
+   */
+  static timestampFrom(snowflake) {
+    return Number(BigInt(snowflake) >> 22n) + EPOCH;
+  }
+
+  /**
+   * Discord's epoch value (2015-01-01T00:00:00.000Z).
+   * @type {number}
+   * @readonly
+   */
+  static get EPOCH() {
+    return EPOCH;
+  }
+}
+
+module.exports = SnowflakeUtil;

package/src/util/Speaking.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const BitField = require('./BitField');
+
+/**
+ * Data structure that makes it easy to interact with a {@link VoiceConnection#speaking}
+ * and {@link guildMemberSpeaking} event bitfields.
+ * @extends {BitField}
+ */
+class Speaking extends BitField {}
+
+/**
+ * @name Speaking
+ * @kind constructor
+ * @memberof Speaking
+ * @param {BitFieldResolvable} [bits=0] Bit(s) to read from
+ */
+
+/**
+ * Numeric speaking flags. All available properties:
+ * * `SPEAKING`
+ * * `SOUNDSHARE`
+ * * `PRIORITY_SPEAKING`
+ * @type {Object}
+ * @see {@link https://discord.com/developers/docs/topics/voice-connections#speaking}
+ */
+Speaking.FLAGS = {
+  SPEAKING: 1 << 0,
+  SOUNDSHARE: 1 << 1,
+  PRIORITY_SPEAKING: 1 << 2,
+};
+
+module.exports = Speaking;