Skip to content
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

Jump to bottom

fix: censor token in debug output #8764

Merged
merged 2 commits into from Oct 27, 2022
Merged

fix: censor token in debug output #8764

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d0e36f
fix: censor token in debug output
almeidx Oct 17, 2022
7210d5c
Merge branch 'main' into discord.js/debug-censor-token
kyranet Oct 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 16 additions & 7 deletions packages/discord.js/src/client/Client.js
View file
Open in desktop
Expand Up @@ -214,13 +214,7 @@ class Client extends BaseClient {
if (!token || typeof token !== 'string') throw new DiscordjsError(ErrorCodes.TokenInvalid);
this.token = token = token.replace(/^(Bot|Bearer)\s*/i, '');
this.rest.setToken(token);
this.emit(
Events.Debug,
`Provided token: ${token
.split('.')
.map((val, i) => (i > 1 ? val.replace(/./g, '*') : val))
.join('.')}`,
);
this.emit(Events.Debug, `Provided token: ${this._censoredToken}`);

if (this.options.presence) {
this.options.ws.presence = this.presence._parse(this.options.presence);
Expand Down Expand Up @@ -459,6 +453,21 @@ class Client extends BaseClient {
});
}

/**
* Partially censored client token for debug logging purposes.
* @type {?string}
* @readonly
* @private
*/
get _censoredToken() {
if (!this.token) return null;

return this.token
.split('.')
.map((val, i) => (i > 1 ? val.replace(/./g, '*') : val))
.join('.');
}

/**
* Calls {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval} on a script
* with the client as `this`.
Expand Down
7 changes: 6 additions & 1 deletion packages/discord.js/src/client/websocket/WebSocketShard.js
View file
Open in desktop
Expand Up @@ -740,7 +740,12 @@ class WebSocketShard extends EventEmitter {
*/
_send(data) {
if (this.connection?.readyState !== WebSocket.OPEN) {
this.debug(`Tried to send packet '${JSON.stringify(data)}' but no WebSocket is available!`);
this.debug(
`Tried to send packet '${JSON.stringify(data).replaceAll(
this.manager.client.token,
this.manager.client._censoredToken,
)}' but no WebSocket is available!`,
);
this.destroy({ closeCode: 4_000 });
return;
}
Expand Down
1 change: 1 addition & 0 deletions packages/discord.js/typings/index.d.ts
View file
Open in desktop
Expand Up @@ -766,6 +766,7 @@ export class Client<Ready extends boolean = boolean> extends BaseClient {
private presence: ClientPresence;
private _eval(script: string): unknown;
private _validateOptions(options: ClientOptions): void;
private get _censoredToken(): string | null;

public application: If<Ready, ClientApplication>;
public channels: ChannelManager;
Expand Down