Skip to content

Commit b604458

Browse files
larabrlarabr
authored
Rename format: 'armor' option to format: 'armored' in top-level functions (#1377)
The `format` option in `openpgp.generateKey, reformatKey, revokeKey, encrypt, sign, encryptSessionKey` now expects the value `'armored'` instead of `'armor'` to output armored data. The other format options (i.e. `'binary'` and `'object'`) remain unchanged.
1 parent ce70484 commit b604458

4 files changed

Lines changed: 44 additions & 44 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ and a subkey for encryption using Curve25519.
446446
curve: 'curve25519', // ECC curve name, defaults to curve25519
447447
userIDs: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs
448448
passphrase: 'super long and hard to guess secret', // protects the private key
449-
format: 'armor' // output key format, defaults to 'armor' (other options: 'binary' or 'object')
449+
format: 'armored' // output key format, defaults to 'armored' (other options: 'binary' or 'object')
450450
});
451451

452452
console.log(privateKey); // '-----BEGIN PGP PRIVATE KEY BLOCK ... '
@@ -476,7 +476,7 @@ Using a revocation certificate:
476476
const { publicKey: revokedKeyArmored } = await openpgp.revokeKey({
477477
key: await openpgp.readKey({ armoredKey: publicKeyArmored }),
478478
revocationCertificate,
479-
format: 'armor' // output armored keys
479+
format: 'armored' // output armored keys
480480
});
481481
console.log(revokedKeyArmored); // '-----BEGIN PGP PUBLIC KEY BLOCK ... '
482482
})();
@@ -487,7 +487,7 @@ Using the private key:
487487
(async () => {
488488
const { publicKey: revokedKeyArmored } = await openpgp.revokeKey({
489489
key: await openpgp.readKey({ armoredKey: privateKeyArmored }),
490-
format: 'armor' // output armored keys
490+
format: 'armored' // output armored keys
491491
});
492492
console.log(revokedKeyArmored); // '-----BEGIN PGP PUBLIC KEY BLOCK ... '
493493
})();

‎openpgp.d.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,21 @@ export function readPrivateKey(options: { armoredKey: string, config?: PartialCo
1818
export function readPrivateKey(options: { binaryKey: Uint8Array, config?: PartialConfig }): Promise<PrivateKey>;
1919
export function readPrivateKeys(options: { armoredKeys: string, config?: PartialConfig }): Promise<PrivateKey[]>;
2020
export function readPrivateKeys(options: { binaryKeys: Uint8Array, config?: PartialConfig }): Promise<PrivateKey[]>;
21-
export function generateKey(options: KeyOptions & { format?: 'armor' }): Promise<SerializedKeyPair<string> & { revocationCertificate: string }>;
21+
export function generateKey(options: KeyOptions & { format?: 'armored' }): Promise<SerializedKeyPair<string> & { revocationCertificate: string }>;
2222
export function generateKey(options: KeyOptions & { format: 'binary' }): Promise<SerializedKeyPair<Uint8Array> & { revocationCertificate: string }>;
2323
export function generateKey(options: KeyOptions & { format: 'object' }): Promise<KeyPair & { revocationCertificate: string }>;
2424
export function decryptKey(options: { privateKey: PrivateKey; passphrase?: MaybeArray<string>; config?: PartialConfig }): Promise<PrivateKey>;
2525
export function encryptKey(options: { privateKey: PrivateKey; passphrase?: MaybeArray<string>; config?: PartialConfig }): Promise<PrivateKey>;
26-
export function reformatKey(options: { privateKey: PrivateKey; userIDs?: MaybeArray<UserID>; passphrase?: string; keyExpirationTime?: number; date?: Date, format?: 'armor', config?: PartialConfig }): Promise<SerializedKeyPair<string> & { revocationCertificate: string }>;
26+
export function reformatKey(options: { privateKey: PrivateKey; userIDs?: MaybeArray<UserID>; passphrase?: string; keyExpirationTime?: number; date?: Date, format?: 'armored', config?: PartialConfig }): Promise<SerializedKeyPair<string> & { revocationCertificate: string }>;
2727
export function reformatKey(options: { privateKey: PrivateKey; userIDs?: MaybeArray<UserID>; passphrase?: string; keyExpirationTime?: number; date?: Date, format: 'binary', config?: PartialConfig }): Promise<SerializedKeyPair<Uint8Array> & { revocationCertificate: string }>;
2828
export function reformatKey(options: { privateKey: PrivateKey; userIDs?: MaybeArray<UserID>; passphrase?: string; keyExpirationTime?: number; date?: Date, format: 'object', config?: PartialConfig }): Promise<KeyPair & { revocationCertificate: string }>;
29-
export function revokeKey(options: { key: PrivateKey, reasonForRevocation?: ReasonForRevocation, date?: Date, format?: 'armor', config?: PartialConfig }): Promise<SerializedKeyPair<string>>;
29+
export function revokeKey(options: { key: PrivateKey, reasonForRevocation?: ReasonForRevocation, date?: Date, format?: 'armored', config?: PartialConfig }): Promise<SerializedKeyPair<string>>;
3030
export function revokeKey(options: { key: PrivateKey, reasonForRevocation?: ReasonForRevocation, date?: Date, format: 'binary', config?: PartialConfig }): Promise<SerializedKeyPair<Uint8Array>>;
3131
export function revokeKey(options: { key: PrivateKey, reasonForRevocation?: ReasonForRevocation, date?: Date, format: 'object', config?: PartialConfig }): Promise<KeyPair>;
32-
export function revokeKey(options: { key: PrivateKey, revocationCertificate: string, date?: Date, format?: 'armor', config?: PartialConfig }): Promise<SerializedKeyPair<string>>;
32+
export function revokeKey(options: { key: PrivateKey, revocationCertificate: string, date?: Date, format?: 'armored', config?: PartialConfig }): Promise<SerializedKeyPair<string>>;
3333
export function revokeKey(options: { key: PrivateKey, revocationCertificate: string, date?: Date, format: 'binary', config?: PartialConfig }): Promise<SerializedKeyPair<Uint8Array>>;
3434
export function revokeKey(options: { key: PrivateKey, revocationCertificate: string, date?: Date, format: 'object', config?: PartialConfig }): Promise<KeyPair>;
35-
export function revokeKey(options: { key: PublicKey, revocationCertificate: string, date?: Date, format?: 'armor', config?: PartialConfig }): Promise<{ publicKey: string, privateKey: null }>;
35+
export function revokeKey(options: { key: PublicKey, revocationCertificate: string, date?: Date, format?: 'armored', config?: PartialConfig }): Promise<{ publicKey: string, privateKey: null }>;
3636
export function revokeKey(options: { key: PublicKey, revocationCertificate: string, date?: Date, format: 'binary', config?: PartialConfig }): Promise<{ publicKey: Uint8Array, privateKey: null }>;
3737
export function revokeKey(options: { key: PublicKey, revocationCertificate: string, date?: Date, format: 'object', config?: PartialConfig }): Promise<{ publicKey: PublicKey, privateKey: null }>;
3838

@@ -172,7 +172,7 @@ export class CleartextMessage {
172172
/* ############## v5 MSG #################### */
173173
export function generateSessionKey(options: { encryptionKeys: MaybeArray<PublicKey>, date?: Date, encryptionUserIDs?: MaybeArray<UserID>, config?: PartialConfig }): Promise<SessionKey>;
174174
export function encryptSessionKey(options: SessionKey & {
175-
encryptionKeys?: MaybeArray<PublicKey>, passwords?: MaybeArray<string>, format?: 'armor', wildcard?: boolean, encryptionKeyIDs?: MaybeArray<KeyID>, date?: Date, encryptionUserIDs?: MaybeArray<UserID>, config?: PartialConfig
175+
encryptionKeys?: MaybeArray<PublicKey>, passwords?: MaybeArray<string>, format?: 'armored', wildcard?: boolean, encryptionKeyIDs?: MaybeArray<KeyID>, date?: Date, encryptionUserIDs?: MaybeArray<UserID>, config?: PartialConfig
176176
}) : Promise<string>;
177177
export function encryptSessionKey(options: SessionKey & {
178178
encryptionKeys?: MaybeArray<PublicKey>, passwords?: MaybeArray<string>, format: 'binary', wildcard?: boolean, encryptionKeyIDs?: MaybeArray<KeyID>, date?: Date, encryptionUserIDs?: MaybeArray<UserID>, config?: PartialConfig
@@ -188,7 +188,7 @@ export function readMessage<T extends MaybeStream<Uint8Array>>(options: { binary
188188
export function createMessage<T extends MaybeStream<string>>(options: { text: T, filename?: string, date?: Date, type?: DataPacketType }): Promise<Message<T>>;
189189
export function createMessage<T extends MaybeStream<Uint8Array>>(options: { binary: T, filename?: string, date?: Date, type?: DataPacketType }): Promise<Message<T>>;
190190

191-
export function encrypt<T extends MaybeStream<Data>>(options: EncryptOptions & { message: Message<T>, format?: 'armor' }): Promise<
191+
export function encrypt<T extends MaybeStream<Data>>(options: EncryptOptions & { message: Message<T>, format?: 'armored' }): Promise<
192192
T extends WebStream<infer X> ? WebStream<string> :
193193
T extends NodeStream<infer X> ? NodeStream<string> :
194194
string
@@ -200,7 +200,7 @@ export function encrypt<T extends MaybeStream<Data>>(options: EncryptOptions & {
200200
>;
201201
export function encrypt<T extends MaybeStream<Data>>(options: EncryptOptions & { message: Message<T>, format: 'object' }): Promise<Message<T>>;
202202

203-
export function sign<T extends MaybeStream<Data>>(options: SignOptions & { message: Message<T>, format?: 'armor' }): Promise<
203+
export function sign<T extends MaybeStream<Data>>(options: SignOptions & { message: Message<T>, format?: 'armored' }): Promise<
204204
T extends WebStream<infer X> ? WebStream<string> :
205205
T extends NodeStream<infer X> ? NodeStream<string> :
206206
string
@@ -211,7 +211,7 @@ export function sign<T extends MaybeStream<Data>>(options: SignOptions & { messa
211211
Uint8Array
212212
>;
213213
export function sign<T extends MaybeStream<Data>>(options: SignOptions & { message: Message<T>, format: 'object' }): Promise<Message<T>>;
214-
export function sign(options: SignOptions & { message: CleartextMessage, format?: 'armor' }): Promise<string>;
214+
export function sign(options: SignOptions & { message: CleartextMessage, format?: 'armored' }): Promise<string>;
215215
export function sign(options: SignOptions & { message: CleartextMessage, format: 'object' }): Promise<CleartextMessage>;
216216

217217
export function decrypt<T extends MaybeStream<Data>>(options: DecryptOptions & { message: Message<T>, format: 'binary' }): Promise<DecryptMessageResult & {
@@ -583,7 +583,7 @@ interface EncryptOptions {
583583
/** (optional) session key */
584584
sessionKey?: SessionKey;
585585
/** if the return values should be ascii armored or the message/signature objects */
586-
format?: 'armor' | 'binary' | 'object';
586+
format?: 'armored' | 'binary' | 'object';
587587
/** (optional) if the signature should be detached (if true, signature will be added to returned object) */
588588
signature?: Signature;
589589
/** (optional) encrypt as of a certain date */
@@ -626,7 +626,7 @@ interface DecryptOptions {
626626
interface SignOptions {
627627
message: CleartextMessage | Message<MaybeStream<Data>>;
628628
signingKeys?: MaybeArray<PrivateKey>;
629-
format?: 'armor' | 'binary' | 'object';
629+
format?: 'armored' | 'binary' | 'object';
630630
dataType?: DataPacketType;
631631
detached?: boolean;
632632
signingKeyIDs?: MaybeArray<KeyID>;
@@ -672,7 +672,7 @@ interface KeyOptions {
672672
keyExpirationTime?: number;
673673
date?: Date;
674674
subkeys?: SubkeyOptions[];
675-
format?: 'armor' | 'object' | 'binary';
675+
format?: 'armored' | 'object' | 'binary';
676676
config?: PartialConfig;
677677
}
678678

0 commit comments

Comments
 (0)