@dxos/credentials 2.28.1 → 2.28.2-dev.3df58cd5

package/src/auth/authenticator.ts

@@ -12,7 +12,7 @@ import { Keyring } from '../keys';
 import { isSignedMessage, PartyState } from '../party';
 import { codec, KeyType, Message } from '../proto';
 
-const log = debug('dxos:creds:auth');
+const log = debug('dxos:halo:auth');
 
 const MAX_AGE = 24 * 60 * 60; // One day.
 
@@ -20,23 +20,17 @@ const MAX_AGE = 24 * 60 * 60; // One day.
  * Abstract base class for Authenticators.
  * Used by AuthPlugin for authenticating nodes during handshake.
  */
-/* TODO(telackey): Explain here the intention behind the abstract base class: is in the future to have
- *   different authentication methods (besides the current PartyAuthenticator) for replication auth,
- *   or to use this base class everywhere auth is done in the project (not used in greeting at present, for example)?
- */
+// TODO(telackey): Explain here the intention behind the abstract base class:
+//  E.g., to have different authentication methods (besides the current PartyAuthenticator) for replication auth,
+//  or to use this base class everywhere auth is done in the project (not used in greeting at present, for example)?
 export abstract class Authenticator {
-  /* TODO(dboreham): The following static methods:
-   * temporary work around move encapsualtion breaking code from `data-client/partitions.js`.
-   */
-  /**
-   * @param {Message} credentials
-   */
+  // TODO(dboreham): The following static methods:
+  //  temporary work around move encapsualtion breaking code from `data-client/partitions.js`.
+
   static encodePayload (credentials: Message) {
     return codec.encode(credentials);
   }
 
-  /**
-   */
   static decodePayload (credentials: Buffer) {
     return codec.decode(credentials);
   }
@@ -74,9 +68,8 @@ export class PartyAuthenticator extends Authenticator {
    * @param credentials
    * @returns {boolean} true if authenticated, else false
    */
-  /* TODO(dboreham): Verify that credentials is a message of type `dxos.credentials.SignedMessage` signing a
-   *  message of type `dxos.credentials.auth.Auth`.
-   */
+  // TODO(dboreham): Verify that credentials is a message of type `dxos.credentials.SignedMessage`
+  //  signing a message of type `dxos.credentials.auth.Auth`.
   override async authenticate (credentials: any) {
     if (!credentials || !isSignedMessage(credentials)) {
       log('Bad credentials:', credentials);
@@ -90,7 +83,8 @@ export class PartyAuthenticator extends Authenticator {
       return false;
     }
 
-    /* TODO(telackey): This is not how it should be done. We would rather use the remote
+    /*
+     * TODO(telackey): This is not how it should be done. We would rather use the remote
      * nonce for anti-replay, but we will need to add hooks for retrieving it and signing it
      * between connect() and handshake() to do that. In the meantime, not allowing infinite replay
      * is at least something.

package/src/greet/greeter-plugin.test.ts

@@ -18,7 +18,7 @@ import { Greeter } from './greeter';
 import { GreetingCommandPlugin } from './greeting-command-plugin';
 import { SecretProvider, SecretValidator } from './invitation';
 
-const log = debug('dxos:creds:greet');
+const log = debug('dxos:halo:greet');
 
 /**
  * Create the Greeter with Plugin and Protocol.

package/src/greet/greeter.ts

@@ -25,7 +25,7 @@ import {
 import { GreetingCommandPlugin } from './greeting-command-plugin';
 import { Invitation, InvitationOnFinish, SecretProvider, SecretValidator } from './invitation';
 
-const log = debug('dxos:creds:greet');
+const log = debug('dxos:halo:greet');
 
 export type PartyWriter = (params: Message[]) => Promise<Message[]>;
 export type HintProvider = (params: Message[]) => Promise<KeyHint[]>;

package/src/greet/greeting-command-plugin.ts

@@ -20,7 +20,7 @@ import { codec, Command } from '../proto';
 import { PeerId } from '../typedefs';
 import { ERR_GREET_GENERAL } from './error-codes';
 
-const log = debug('dxos:creds:greet:plugin'); // eslint-disable-line unused-imports/no-unused-vars
+const log = debug('dxos:halo:greet:plugin'); // eslint-disable-line unused-imports/no-unused-vars
 
 const DEFAULT_TIMEOUT = 30000;
 

package/src/greet/party-invitation-claim-handler.ts

@@ -12,7 +12,7 @@ import { ERR_GREET_GENERAL, ERR_GREET_INVALID_COMMAND, ERR_GREET_INVALID_INVITAT
 import { GreetingCommandPlugin } from './greeting-command-plugin';
 import { createGreetingClaimResponse } from './greeting-message';
 
-const log = debug('dxos:creds:greet:claim');
+const log = debug('dxos:halo:greet:claim');
 
 export type PartyInvitationGreetingHandler = (invitationID: Buffer, remotePeerId: Buffer, peerId: Buffer) => Promise<any>;
 

package/src/identity/identity-message-processor.ts

@@ -13,7 +13,7 @@ import { Keyring, assertValidPublicKey } from '../keys';
 import { PartyState, isEnvelope, isSignedMessage } from '../party';
 import { SignedMessage } from '../proto';
 
-const log = debug('dxos:creds:party');
+const log = debug('dxos:halo:party');
 
 /**
  * Process and manage IdentityInfo, DeviceInfo, and other "identity" Party messages.

package/src/keys/keystore.ts

@@ -14,7 +14,7 @@ import { PublicKey } from '@dxos/crypto';
 
 import { KeyRecord } from '../proto';
 
-const log = debug('dxos:creds:keys:keystore'); // eslint-disable-line unused-imports/no-unused-vars
+const log = debug('dxos:halo:keys:keystore'); // eslint-disable-line unused-imports/no-unused-vars
 
 const marshaller = {
   marshall (record: KeyRecord) {

package/src/party/party-invitation-manager.ts

@@ -11,7 +11,7 @@ import { KeyRecord, SignedMessage } from '../proto';
 import { PartyEventType } from './events';
 import { PartyState } from './party-state';
 
-const log = debug('dxos:creds:party');
+const log = debug('dxos:halo:party');
 
 /**
  * A class to manage the lifecycle of invitations which are written to the Party.

package/src/party/party-invitations.test.js

@@ -20,7 +20,7 @@ import {
 import { PartyState } from './party-state';
 
 // eslint-disable-next-line unused-imports/no-unused-vars
-const log = debug('dxos:creds:party:test');
+const log = debug('dxos:halo:party:test');
 
 const createPartyKeyrings = async () => {
   // This Keyring has all the keypairs, so it is the initial source of things.

package/src/party/party-state.test.js

@@ -21,7 +21,7 @@ import {
 import { PartyState } from './party-state';
 
 // eslint-disable-next-line unused-imports/no-unused-vars
-const log = debug('dxos:creds:party:test');
+const log = debug('dxos:halo:party:test');
 
 const createPartyKeyrings = async () => {
   // This Keyring has all the keypairs, so it is the initial source of things.

package/src/party/party-state.ts

@@ -15,7 +15,7 @@ import { PartyEventType } from './events';
 import { isEnvelope, isPartyInvitationMessage, isSignedMessage } from './party-credential';
 import { PartyInvitationManager } from './party-invitation-manager';
 
-const log = debug('dxos:creds:party');
+const log = debug('dxos:halo:party');
 
 /**
  * The party state is constructed via signed messages on the feeds.