Beginning ofTypescript migration & S2K Gnu case refactor

[Realtin]

This is the beginning of the migration to Typescript. The typescript and rollup configuration are adjusted to support the incremental addition of typescript modules, so it also supports javascript moduls.
All typescript files need to be imported with it's explicit .ts file endings.

• S2K Module: migrated to typescript
• S2K Module: case for gnu types is moved to its own class

[larabr]

Thanks for working on this 🙂
I left a few comments, mostly based on the usages of the s2k modules, which in turn affect some typing choices.
The types can also be stricted when dealing with e.g. enums.s2k values, instead of using plain numbers -- we have the relevant type declarations in openpgp.d.ts.

Finally, I mentioned a logic change we'd like to make with the GnuS2K class & instantiations, but we can also work on that at a later time if it's easier 👌

[larabr]

Suggested change

	algorithm: number;
	type: string;
	c: number;
	/**
	* @param {Object} [config] - Full configuration, defaults to openpgp.config
	*/
	constructor(config = defaultConfig) {
	/**
	* Hash function identifier, or 0 for gnu-dummy keys
	* @type {module:enums.hash | 0}
	*/
	this.algorithm = enums.hash.sha256;
	/**
	* enums.s2k identifier or 'gnu-dummy'
	* @type {String}
	*/
	this.type = 'gnu';
	/**
	* @type {Integer}
	*/
	this.c = config.s2kIterationCountByte;
	}
	type: 'gnu' = 'gnu';
	gnuType: 'gnu-dummy';

None of the rest should be needed anymore 🙂
And, after talking to Daniel, we'd also like to introduce gnuType, instead of reassigning type = 'gnu-dummy', as such value that does not match a enums.s2k .

In turn, that'd require updating some usages in the rest of the code (where we do e.g. s2k.type === 'gnu-dummy' -> s2k.gnuType === 'gnu-dummy').

[larabr]

Suggested change

	export function newS2KFromConfig(config = defaultConfig) {
	export function newS2KFromConfig(config: Config) {

we want the caller to not forget to pass this explicitly in this case 🙂

[larabr]

Suggested change

	const arr: number[] = [];
	let rlength = 0;
	while (rlength < numBytes) {
	if (this.type !== 'gnu') {
	throw new Error('Unknown s2k type.');
	} else {
	throw new Error('GNU s2k type not supported.');
	}
	}
	return util.concatUint8Array(arr).subarray(0, numBytes);
	}
	throw new Error('Gnu S2K does not support producing keys');

✂️

[larabr]

The argon2 module is typed, I'd take advantage of that

import type { default as loadArgonWasmModuleType, computeHashType } from 'argon2id';

let loadArgonWasmModule: typeof loadArgonWasmModuleType;
let argon2Promise: Promise<computeHashType>; // or `ReturnType<typeof loadArgonWasmModuleType>

[larabr]

Suggested change

	type: string;
	salt: Uint8Array | null;
	t: number;
	p: number;
	encodedM: number;
	type: 'argon2';
	private salt: Uint8Array | null;
	private t: number;
	private p: number;
	private encodedM: number;

I think we can be quite strict here 🙂

[larabr]

These docs don't apply to the new class -- I leave this just as reminder to either remove the comments, or update them 🙂

[Realtin]

I'll remove the comment

[larabr]

Suggested change

	constructor(s2kType: number, config = defaultConfig) {
	constructor(s2kType: enums.s2k.simple | enums.s2k.salted | enums.s2k.iterated, config = defaultConfig) {

[larabr]

Suggested change

	algorithm: number;
	type: string;
	c: number;
	salt: Uint8Array | null;
	private algorithm: enums.hash;
	type: enums.s2k.simple | enums.s2k.salted | enums.s2k.iterated;
	private c: number;
	private salt: Uint8Array | null;

and also the getCount() method can be private 🙂

[larabr]

Better to throw here (same for the 'iterated' case that follows), or I think it gives the wrong impression that the salt is optional 🙂

Suggested change

	this.salt && arr.push(this.salt);
	if (!salt) { throw Error('Salt was not set') }
	arr.push(this.salt);

[larabr]

Suggested change

	class GnuS2k {
	class GnuS2K {

[ayhamthemayhem]

Hey 👋 We have addressed almost every comment on this PR 🙂 but I did notice one thing in argon2.ts which is using the argon2id package and you mentioned it would be a good idea to leverage the types from the in your comment here but I noticed we are passing ARGON2_TYPE and ARGON2_VERSION to Argon2idParams object which are not used or declared in the Argon2idParams type :/ and even commenting out those values does not break the build or the tests. I added a ts-ignore to not have typescript throw errors on us for now until this is more clear.