Please provide documentation for the pkcs8 related constants in keyring

[clearloop]

Documentation requests

• Bug report
• Feature request
• Support request
• Other

• What is the current behavior and expected behavior?

common/packages/keyring/src/pair/defaults.ts

Lines 4 to 5 in 6971012

	export const PKCS8_DIVIDER = new Uint8Array([161, 35, 3, 33, 0]);
	export const PKCS8_HEADER = new Uint8Array([48, 83, 2, 1, 1, 48, 5, 6, 3, 43, 101, 112, 4, 34, 4, 32]);

// review: where are these bytes from, what's the exact meaning of them
export const PKCS8_DIVIDER = new Uint8Array([161, 35, 3, 33, 0]);
// review: same
export const PKCS8_HEADER = new Uint8Array([48, 83, 2, 1, 1, 48, 5, 6, 3, 43, 101, 112, 4, 34, 4, 32]);

the header and divider here seems not following the private key information syntax defined in RFC5208-section-5

PrivateKeyInfo ::= SEQUENCE {
        version                   Version,
        privateKeyAlgorithm       PrivateKeyAlgorithmIdentifier,
        privateKey                PrivateKey,
        attributes           [0]  IMPLICIT Attributes OPTIONAL }

Version ::= INTEGER
PrivateKeyAlgorithmIdentifier ::= AlgorithmIdentifier
PrivateKey ::= OCTET STRING
Attributes ::= SET OF Attribute

both encode and decode methods are using these constants without any description, no tests provided, just hardcode bytes level checks

common/packages/keyring/src/pair/encode.ts

Lines 16 to 21 in 6971012

	const encoded = u8aConcat(
	PKCS8_HEADER,
	secretKey,
	PKCS8_DIVIDER,
	publicKey
	);

common/packages/keyring/src/pair/decode.ts

Lines 25 to 27 in 6971012

	if (!u8aEq(header, PKCS8_HEADER)) {
	throw new Error('Invalid Pkcs8 header found in body');
	}

[jacogr]

Closed in #1910 - be aware that these constants should not be relied upon, only the exposed interfaces for decode/encode, it is bound to change.

(There are still a large number of files which have not been commented, in this repo and others - especially on types, it is a "ahh, this needs work and I'm here" effort)

[polkadot-js-bot]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue if you think you have a related problem or query.