Details

Reviewers

atul
ashoat
• jon

Commits

rCOMMcaf85e1e400a: [keyserver] call identity service during account creation and deletion

Summary

when we create a new account with a username, we should add it to the reserved usernames list
being maintained by the identity service.

when we delete an existing account with a username, we should remove it from the reserved usernames list being maintained by the identity service.

Depends on D8299

Test Plan

tested this by creating and deleting a new user locally. saw that the username was added to and then removed from my ddb table in localstack.

also tried removing a reserved username that didn't exist in ddb and got back an error as expected.

Diff Detail

Repository

rCOMM Comm

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

varun created this revision.Jun 22 2023, 11:46 PM

Herald added subscribers: tomek, ashoat. · View Herald TranscriptJun 22 2023, 11:46 PM

fix import duplication

Harbormaster failed remote builds in B20446: Diff 28028!Jun 22 2023, 11:58 PM

Harbormaster returned this revision to the author for changes because remote builds failed.Jun 23 2023, 12:12 AM

Harbormaster failed remote builds in B20447: Diff 28029!

changes to satisfy jest

Harbormaster completed remote builds in B20484: Diff 28070.Jun 23 2023, 1:40 PM

varun requested review of this revision.Jun 23 2023, 1:40 PM

Seems right at a high level, adding @ashoat as blocking to take a look at babel-plugin-transform-import-meta dependency and related changes.

keyserver/src/creators/account-creator.js
220 ↗	(On Diff #28070)	Should this "magic string" be defined somewhere that's shared?

varun added inline comments.Jun 26 2023, 11:33 AM

keyserver/src/creators/account-creator.js
220 ↗	(On Diff #28070)	that's a fair point

address feedback

varun added a parent revision: D8328: change AddReservedUsername to AddReservedUsernames.Jun 27 2023, 7:01 AM

Harbormaster completed remote builds in B20539: Diff 28166.Jun 27 2023, 7:18 AM

varun added a child revision: D8330: [keyserver] fetchUsernames helper function.Jun 27 2023, 7:46 AM

varun mentioned this in D8331: [keyserver] cron job to sync reserved usernames.Jun 27 2023, 8:27 AM

This diff should be split, and more work should be done to explain the changes and why they're necessary

keyserver/addons/rust-node-addon/index.js
16–19 ↗	(On Diff #28166)	No idea what this is about or why it's being introduced! This needs to be explained in the diff description...
keyserver/babel.config.cjs
11 ↗	(On Diff #28166)	No idea why this is necessary
keyserver/package.json
34 ↗	(On Diff #28166)	It really would've made it easier to review if you had split this part out into its own diff
keyserver/src/shared/message-statements.js
3–7 ↗	(On Diff #28166)	Why do these need to be human-readable? Does this need to be synced with some equivalent strings on the Rust side? If so, it would be better to avoid the copy-paste, but if it's necessary then you need to do some extra work to make sure the reader is aware of this strong requirement. Otherwise it's really easy for the expectation to be broken, as you've done nothing to make the requirement discoverable
lib/types/crypto-types.js
43 ↗	(On Diff #28166)	Why don't we always take a `$ReadOnlyArray<string>`? If there's some strong reason we need to take `string \| $ReadOnlyArray<string>, then I think we should type it that way, and avoid generics. I suspect that the payload needs to be a specific format for the Rust call, so we should enforce that on the JS side

This revision now requires changes to proceed.Jun 28 2023, 5:26 PM

ashoat added inline comments.Jun 28 2023, 5:31 PM

lib/types/crypto-types.js

41–45 ↗

(On Diff #28166)

I think this would be a better type:

export type ReservedUsernameMessage = {
  +mutationType: 'add' | 'remove',
  +userIDs: $ReadOnlyArray<string>,
  +issuedAt: string,
};

If you absolutely need to make the payload only take a single string for deletes, you could do this:

export type ReservedUsernameMessage =
  | {
      +mutationType: 'add',
      +userIDs: $ReadOnlyArray<string>,
      +issuedAt: string,
    }
  | {
      +mutationType: 'remove',
      +userID: string,
      +issuedAt: string,
    };

address feedback

varun added a parent revision: D8406: [keyserver] Add conditional handling for import.meta in tests and update Babel configuration.Jun 30 2023, 9:40 PM

varun removed a parent revision: D8328: change AddReservedUsername to AddReservedUsernames.

Harbormaster completed remote builds in B20667: Diff 28323.Jun 30 2023, 9:58 PM

varun added inline comments.Jun 30 2023, 9:59 PM

keyserver/addons/rust-node-addon/index.js
16–19 ↗	(On Diff #28166)	split this out into a separate diff
keyserver/babel.config.cjs
11 ↗	(On Diff #28166)	this is in a separate diff now
keyserver/src/shared/message-statements.js
3–7 ↗	(On Diff #28166)	it doesn't need to be human-readable, actually. we can simplify this. follow up task: https://linear.app/comm/issue/ENG-4296/reduce-message-statement-to-just-a-verb
lib/types/crypto-types.js
41–45 ↗	(On Diff #28166)	to avoid making changes on the identity service, i'm doing the following for now: export type ReservedUsernameMessage = \| { +statement: 'Add the following usernames to reserved list', +payload: $ReadOnlyArray<string>, +issuedAt: string, } \| { +statement: 'Remove the following username from reserved list', +payload: string, +issuedAt: string, }; will address further type improvements in this follow-up task: https://linear.app/comm/issue/ENG-4295/simplify-reservedusernamemessage-type-on-keyserver
43 ↗	(On Diff #28166)	Why don't we always take a $ReadOnlyArray<string>? we don't have a use case for a batch delete, but this would simplify things a bit on the keyserver side. created a follow-up task: https://linear.app/comm/issue/ENG-4294/update-removereservedusername-rpc-to-take-a-list-of-usernames

ashoat accepted this revision.Jul 2 2023, 11:36 AM

ashoat added inline comments.

lib/types/crypto-types.js
42 ↗	(On Diff #28323)	Can you make sure we add the equivalent text on the Rust side?

This revision is now accepted and ready to land.Jul 2 2023, 11:36 AM

Closed by commit rCOMMcaf85e1e400a: [keyserver] call identity service during account creation and deletion (authored by varun). · Explain WhyJul 3 2023, 8:39 PM

This revision was automatically updated to reflect the committed changes.

varun added a commit: rCOMMcaf85e1e400a: [keyserver] call identity service during account creation and deletion.

Herald added a reviewer: • jon. · View Herald TranscriptJul 3 2023, 8:39 PM

varun mentioned this in D8533: [keyserver] rename napi add_reserved_usernames function.Jul 18 2023, 12:38 PM

varun mentioned this in rCOMMeabd32112e35: [keyserver] rename napi add_reserved_usernames function.Jul 18 2023, 2:24 PM

Diff 28370

View Options

keyserver/src/creators/account-creator.js

// @flow		// @flow

import olm from '@commapp/olm';		import olm from '@commapp/olm';
import type {		import type {
Account as OlmAccount,		Account as OlmAccount,
Utility as OlmUtility,		Utility as OlmUtility,
		Session as OlmSession,
} from '@commapp/olm';		} from '@commapp/olm';
import uuid from 'uuid';		import uuid from 'uuid';

type PickledOlmAccount = {		type PickledOlmAccount = {
+picklingKey: string,		+picklingKey: string,
+pickledAccount: string,		+pickledAccount: string,
};		};

Show All 22 Lines	): Promise<OlmAccount> {

account.unpickle(		account.unpickle(
pickledOlmAccount.picklingKey,		pickledOlmAccount.picklingKey,
pickledOlmAccount.pickledAccount,		pickledOlmAccount.pickledAccount,
);		);
return account;		return account;
}		}

		async function createPickledOlmSession(
		account: OlmAccount,
		accountPicklingKey: string,
		initialEncryptedMessage: string,
		): Promise<string> {
		await olm.init();
		const session = new olm.Session();
		session.create_inbound(account, initialEncryptedMessage);
		account.remove_one_time_keys(session);
		session.decrypt(0, initialEncryptedMessage);
		ashoatUnsubmitted Not Done Inline Actions Let's avoid passing constants as number literals like this. Instead, please define something like eg. `threadTypes`, so that this code is more "readable" at the callsite (eg. we would see something like `olmMessageTypes.TEXT` or something) ashoat: Let's avoid passing constants as number literals like this. Instead, please define something…
		return session.pickle(accountPicklingKey);
		}

		async function unpickleOlmSession(
		pickledSession: string,
		picklingKey: string,
		): Promise<OlmSession> {
		await olm.init();
		const session = new olm.Session();
		session.unpickle(picklingKey, pickledSession);
		return session;
		}

let cachedOLMUtility: OlmUtility;		let cachedOLMUtility: OlmUtility;
function getOlmUtility(): OlmUtility {		function getOlmUtility(): OlmUtility {
if (cachedOLMUtility) {		if (cachedOLMUtility) {
return cachedOLMUtility;		return cachedOLMUtility;
}		}
cachedOLMUtility = new olm.Utility();		cachedOLMUtility = new olm.Utility();
return cachedOLMUtility;		return cachedOLMUtility;
}		}
Show All 26 Lines	if (
currentDate - lastPrekeyPublishDate >= maxOldPrekeyAge		currentDate - lastPrekeyPublishDate >= maxOldPrekeyAge
) {		) {
account.forget_old_prekey();		account.forget_old_prekey();
}		}
}		}

export {		export {
createPickledOlmAccount,		createPickledOlmAccount,
		createPickledOlmSession,
getOlmUtility,		getOlmUtility,
unpickleOlmAccount,		unpickleOlmAccount,
		unpickleOlmSession,
validateAccountPrekey,		validateAccountPrekey,
};		};

View Options

keyserver/src/deleters/account-deleters.js

// @flow		// @flow

import olm from '@commapp/olm';		import olm from '@commapp/olm';
import type {		import type {
Account as OlmAccount,		Account as OlmAccount,
Utility as OlmUtility,		Utility as OlmUtility,
		Session as OlmSession,
} from '@commapp/olm';		} from '@commapp/olm';
import uuid from 'uuid';		import uuid from 'uuid';

type PickledOlmAccount = {		type PickledOlmAccount = {
+picklingKey: string,		+picklingKey: string,
+pickledAccount: string,		+pickledAccount: string,
};		};

Show All 22 Lines	): Promise<OlmAccount> {

account.unpickle(		account.unpickle(
pickledOlmAccount.picklingKey,		pickledOlmAccount.picklingKey,
pickledOlmAccount.pickledAccount,		pickledOlmAccount.pickledAccount,
);		);
return account;		return account;
}		}

		async function createPickledOlmSession(
		account: OlmAccount,
		accountPicklingKey: string,
		initialEncryptedMessage: string,
		): Promise<string> {
		await olm.init();
		const session = new olm.Session();
		session.create_inbound(account, initialEncryptedMessage);
		account.remove_one_time_keys(session);
		session.decrypt(0, initialEncryptedMessage);
		ashoatUnsubmitted Not Done Inline Actions Let's avoid passing constants as number literals like this. Instead, please define something like eg. `threadTypes`, so that this code is more "readable" at the callsite (eg. we would see something like `olmMessageTypes.TEXT` or something) ashoat: Let's avoid passing constants as number literals like this. Instead, please define something…
		return session.pickle(accountPicklingKey);
		}

		async function unpickleOlmSession(
		pickledSession: string,
		picklingKey: string,
		): Promise<OlmSession> {
		await olm.init();
		const session = new olm.Session();
		session.unpickle(picklingKey, pickledSession);
		return session;
		}

let cachedOLMUtility: OlmUtility;		let cachedOLMUtility: OlmUtility;
function getOlmUtility(): OlmUtility {		function getOlmUtility(): OlmUtility {
if (cachedOLMUtility) {		if (cachedOLMUtility) {
return cachedOLMUtility;		return cachedOLMUtility;
}		}
cachedOLMUtility = new olm.Utility();		cachedOLMUtility = new olm.Utility();
return cachedOLMUtility;		return cachedOLMUtility;
}		}
Show All 26 Lines	if (
currentDate - lastPrekeyPublishDate >= maxOldPrekeyAge		currentDate - lastPrekeyPublishDate >= maxOldPrekeyAge
) {		) {
account.forget_old_prekey();		account.forget_old_prekey();
}		}
}		}

export {		export {
createPickledOlmAccount,		createPickledOlmAccount,
		createPickledOlmSession,
getOlmUtility,		getOlmUtility,
unpickleOlmAccount,		unpickleOlmAccount,
		unpickleOlmSession,
validateAccountPrekey,		validateAccountPrekey,
};		};

View Options

lib/types/crypto-types.js

// @flow		// @flow

import olm from '@commapp/olm';		import olm from '@commapp/olm';
import type {		import type {
Account as OlmAccount,		Account as OlmAccount,
Utility as OlmUtility,		Utility as OlmUtility,
		Session as OlmSession,
} from '@commapp/olm';		} from '@commapp/olm';
import uuid from 'uuid';		import uuid from 'uuid';

type PickledOlmAccount = {		type PickledOlmAccount = {
+picklingKey: string,		+picklingKey: string,
+pickledAccount: string,		+pickledAccount: string,
};		};

Show All 22 Lines	): Promise<OlmAccount> {

account.unpickle(		account.unpickle(
pickledOlmAccount.picklingKey,		pickledOlmAccount.picklingKey,
pickledOlmAccount.pickledAccount,		pickledOlmAccount.pickledAccount,
);		);
return account;		return account;
}		}

		async function createPickledOlmSession(
		account: OlmAccount,
		accountPicklingKey: string,
		initialEncryptedMessage: string,
		): Promise<string> {
		await olm.init();
		const session = new olm.Session();
		session.create_inbound(account, initialEncryptedMessage);
		account.remove_one_time_keys(session);
		session.decrypt(0, initialEncryptedMessage);
		ashoatUnsubmitted Not Done Inline Actions Let's avoid passing constants as number literals like this. Instead, please define something like eg. `threadTypes`, so that this code is more "readable" at the callsite (eg. we would see something like `olmMessageTypes.TEXT` or something) ashoat: Let's avoid passing constants as number literals like this. Instead, please define something…
		return session.pickle(accountPicklingKey);
		}

		async function unpickleOlmSession(
		pickledSession: string,
		picklingKey: string,
		): Promise<OlmSession> {
		await olm.init();
		const session = new olm.Session();
		session.unpickle(picklingKey, pickledSession);
		return session;
		}

let cachedOLMUtility: OlmUtility;		let cachedOLMUtility: OlmUtility;
function getOlmUtility(): OlmUtility {		function getOlmUtility(): OlmUtility {
if (cachedOLMUtility) {		if (cachedOLMUtility) {
return cachedOLMUtility;		return cachedOLMUtility;
}		}
cachedOLMUtility = new olm.Utility();		cachedOLMUtility = new olm.Utility();
return cachedOLMUtility;		return cachedOLMUtility;
}		}
Show All 26 Lines	if (
currentDate - lastPrekeyPublishDate >= maxOldPrekeyAge		currentDate - lastPrekeyPublishDate >= maxOldPrekeyAge
) {		) {
account.forget_old_prekey();		account.forget_old_prekey();
}		}
}		}

export {		export {
createPickledOlmAccount,		createPickledOlmAccount,
		createPickledOlmSession,
getOlmUtility,		getOlmUtility,
unpickleOlmAccount,		unpickleOlmAccount,
		unpickleOlmSession,
validateAccountPrekey,		validateAccountPrekey,
};		};

View Options

services/identity/src/reserved_users.rs

// @flow		// @flow

import olm from '@commapp/olm';		import olm from '@commapp/olm';
import type {		import type {
Account as OlmAccount,		Account as OlmAccount,
Utility as OlmUtility,		Utility as OlmUtility,
		Session as OlmSession,
} from '@commapp/olm';		} from '@commapp/olm';
import uuid from 'uuid';		import uuid from 'uuid';

type PickledOlmAccount = {		type PickledOlmAccount = {
+picklingKey: string,		+picklingKey: string,
+pickledAccount: string,		+pickledAccount: string,
};		};

Show All 22 Lines	): Promise<OlmAccount> {

account.unpickle(		account.unpickle(
pickledOlmAccount.picklingKey,		pickledOlmAccount.picklingKey,
pickledOlmAccount.pickledAccount,		pickledOlmAccount.pickledAccount,
);		);
return account;		return account;
}		}

		async function createPickledOlmSession(
		account: OlmAccount,
		accountPicklingKey: string,
		initialEncryptedMessage: string,
		): Promise<string> {
		await olm.init();
		const session = new olm.Session();
		session.create_inbound(account, initialEncryptedMessage);
		account.remove_one_time_keys(session);
		session.decrypt(0, initialEncryptedMessage);
		ashoatUnsubmitted Not Done Inline Actions Let's avoid passing constants as number literals like this. Instead, please define something like eg. `threadTypes`, so that this code is more "readable" at the callsite (eg. we would see something like `olmMessageTypes.TEXT` or something) ashoat: Let's avoid passing constants as number literals like this. Instead, please define something…
		return session.pickle(accountPicklingKey);
		}

		async function unpickleOlmSession(
		pickledSession: string,
		picklingKey: string,
		): Promise<OlmSession> {
		await olm.init();
		const session = new olm.Session();
		session.unpickle(picklingKey, pickledSession);
		return session;
		}

let cachedOLMUtility: OlmUtility;		let cachedOLMUtility: OlmUtility;
function getOlmUtility(): OlmUtility {		function getOlmUtility(): OlmUtility {
if (cachedOLMUtility) {		if (cachedOLMUtility) {
return cachedOLMUtility;		return cachedOLMUtility;
}		}
cachedOLMUtility = new olm.Utility();		cachedOLMUtility = new olm.Utility();
return cachedOLMUtility;		return cachedOLMUtility;
}		}
Show All 26 Lines	if (
currentDate - lastPrekeyPublishDate >= maxOldPrekeyAge		currentDate - lastPrekeyPublishDate >= maxOldPrekeyAge
) {		) {
account.forget_old_prekey();		account.forget_old_prekey();
}		}
}		}

export {		export {
createPickledOlmAccount,		createPickledOlmAccount,
		createPickledOlmSession,
getOlmUtility,		getOlmUtility,
unpickleOlmAccount,		unpickleOlmAccount,
		unpickleOlmSession,
validateAccountPrekey,		validateAccountPrekey,
};		};

[keyserver] call identity service during account creation and deletion
ClosedPublic
Actions

Details

Diff Detail

Event Timeline

Revision Contents
Changeset List

Diff 28370

keyserver/src/creators/account-creator.js

keyserver/src/deleters/account-deleters.js

lib/types/crypto-types.js

services/identity/src/reserved_users.rs

[keyserver] call identity service during account creation and deletionClosedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 28370

keyserver/src/creators/account-creator.js

keyserver/src/deleters/account-deleters.js

lib/types/crypto-types.js

services/identity/src/reserved_users.rs

[keyserver] call identity service during account creation and deletion
ClosedPublic
Actions

Revision Contents
Changeset List