@certd/acme-client 0.1.6 → 0.2.0

package/types/index.d.ts

@@ -1,141 +1,141 @@
-/**
- * acme-client type definitions
- */
-
-import { AxiosInstance } from 'axios';
-import * as rfc8555 from './rfc8555';
-
-export type PrivateKeyBuffer = Buffer;
-export type PublicKeyBuffer = Buffer;
-export type CertificateBuffer = Buffer;
-export type CsrBuffer = Buffer;
-
-export type PrivateKeyString = string;
-export type PublicKeyString = string;
-export type CertificateString = string;
-export type CsrString = string;
-
-
-/**
- * Augmented ACME interfaces
- */
-
-export interface Order extends rfc8555.Order {
-    url: string;
-}
-
-export interface Authorization extends rfc8555.Authorization {
-    url: string;
-}
-
-
-/**
- * Client
- */
-
-export interface ClientOptions {
-    directoryUrl: string;
-    accountKey: PrivateKeyBuffer | PrivateKeyString;
-    accountUrl?: string;
-    backoffAttempts?: number;
-    backoffMin?: number;
-    backoffMax?: number;
-}
-
-export interface ClientAutoOptions {
-    csr: CsrBuffer | CsrString;
-    challengeCreateFn: (authz: Authorization, challenge: rfc8555.Challenge, keyAuthorization: string) => Promise<any>;
-    challengeRemoveFn: (authz: Authorization, challenge: rfc8555.Challenge, keyAuthorization: string) => Promise<any>;
-    email?: string;
-    termsOfServiceAgreed?: boolean;
-    skipChallengeVerification?: boolean;
-    challengePriority?: string[];
-    preferredChain?: string;
-}
-
-export class Client {
-    constructor(opts: ClientOptions);
-    getTermsOfServiceUrl(): Promise<string>;
-    getAccountUrl(): string;
-    createAccount(data?: rfc8555.AccountCreateRequest): Promise<rfc8555.Account>;
-    updateAccount(data?: rfc8555.AccountUpdateRequest): Promise<rfc8555.Account>;
-    updateAccountKey(newAccountKey: PrivateKeyBuffer | PrivateKeyString, data?: object): Promise<rfc8555.Account>;
-    createOrder(data: rfc8555.OrderCreateRequest): Promise<Order>;
-    getOrder(order: Order): Promise<Order>;
-    finalizeOrder(order: Order, csr: CsrBuffer | CsrString): Promise<Order>;
-    getAuthorizations(order: Order): Promise<Authorization[]>;
-    deactivateAuthorization(authz: Authorization): Promise<Authorization>;
-    getChallengeKeyAuthorization(challenge: rfc8555.Challenge): Promise<string>;
-    verifyChallenge(authz: Authorization, challenge: rfc8555.Challenge): Promise<boolean>;
-    completeChallenge(challenge: rfc8555.Challenge): Promise<rfc8555.Challenge>;
-    waitForValidStatus<T = Order | Authorization | rfc8555.Challenge>(item: T): Promise<T>;
-    getCertificate(order: Order, preferredChain?: string | null): Promise<string>;
-    revokeCertificate(cert: CertificateBuffer | CertificateString, data?: rfc8555.CertificateRevocationRequest): Promise<void>;
-    auto(opts: ClientAutoOptions): Promise<string>;
-}
-
-
-/**
- * Directory URLs
- */
-
-export const directory: {
-    letsencrypt: {
-        staging: string,
-        production: string
-    }
-};
-
-
-/**
- * Crypto
- */
-
-export interface CertificateDomains {
-    commonName: string;
-    altNames: string[];
-}
-
-export interface CertificateIssuer {
-    commonName: string;
-}
-
-export interface CertificateInfo {
-    issuer: CertificateIssuer;
-    domains: CertificateDomains;
-    notAfter: Date;
-    notBefore: Date;
-}
-
-export interface CsrOptions {
-    keySize?: number;
-    commonName?: string;
-    altNames?: string[];
-    country?: string;
-    state?: string;
-    locality?: string;
-    organization?: string;
-    organizationUnit?: string;
-    emailAddress?: string;
-}
-
-export interface CryptoInterface {
-    createPrivateKey(size?: number): Promise<PrivateKeyBuffer>;
-    createPublicKey(key: PrivateKeyBuffer | PrivateKeyString): Promise<PublicKeyBuffer>;
-    getPemBody(str: string): string;
-    splitPemChain(str: string): string[];
-    getModulus(input: PrivateKeyBuffer | PrivateKeyString | PublicKeyBuffer | PublicKeyString | CertificateBuffer | CertificateString | CsrBuffer | CsrString): Promise<Buffer>;
-    getPublicExponent(input: PrivateKeyBuffer | PrivateKeyString | PublicKeyBuffer | PublicKeyString | CertificateBuffer | CertificateString | CsrBuffer | CsrString): Promise<Buffer>;
-    readCsrDomains(csr: CsrBuffer | CsrString): Promise<CertificateDomains>;
-    readCertificateInfo(cert: CertificateBuffer | CertificateString): Promise<CertificateInfo>;
-    createCsr(data: CsrOptions, key?: PrivateKeyBuffer | PrivateKeyString): Promise<[PrivateKeyBuffer, CsrBuffer]>;
-}
-
-export const forge: CryptoInterface;
-
-
-/**
- * Axios
- */
-
-export const axios: AxiosInstance;
+/**
+ * acme-client type definitions
+ */
+
+import { AxiosInstance } from 'axios';
+import * as rfc8555 from './rfc8555';
+
+export type PrivateKeyBuffer = Buffer;
+export type PublicKeyBuffer = Buffer;
+export type CertificateBuffer = Buffer;
+export type CsrBuffer = Buffer;
+
+export type PrivateKeyString = string;
+export type PublicKeyString = string;
+export type CertificateString = string;
+export type CsrString = string;
+
+
+/**
+ * Augmented ACME interfaces
+ */
+
+export interface Order extends rfc8555.Order {
+    url: string;
+}
+
+export interface Authorization extends rfc8555.Authorization {
+    url: string;
+}
+
+
+/**
+ * Client
+ */
+
+export interface ClientOptions {
+    directoryUrl: string;
+    accountKey: PrivateKeyBuffer | PrivateKeyString;
+    accountUrl?: string;
+    backoffAttempts?: number;
+    backoffMin?: number;
+    backoffMax?: number;
+}
+
+export interface ClientAutoOptions {
+    csr: CsrBuffer | CsrString;
+    challengeCreateFn: (authz: Authorization, challenge: rfc8555.Challenge, keyAuthorization: string) => Promise<any>;
+    challengeRemoveFn: (authz: Authorization, challenge: rfc8555.Challenge, keyAuthorization: string) => Promise<any>;
+    email?: string;
+    termsOfServiceAgreed?: boolean;
+    skipChallengeVerification?: boolean;
+    challengePriority?: string[];
+    preferredChain?: string;
+}
+
+export class Client {
+    constructor(opts: ClientOptions);
+    getTermsOfServiceUrl(): Promise<string>;
+    getAccountUrl(): string;
+    createAccount(data?: rfc8555.AccountCreateRequest): Promise<rfc8555.Account>;
+    updateAccount(data?: rfc8555.AccountUpdateRequest): Promise<rfc8555.Account>;
+    updateAccountKey(newAccountKey: PrivateKeyBuffer | PrivateKeyString, data?: object): Promise<rfc8555.Account>;
+    createOrder(data: rfc8555.OrderCreateRequest): Promise<Order>;
+    getOrder(order: Order): Promise<Order>;
+    finalizeOrder(order: Order, csr: CsrBuffer | CsrString): Promise<Order>;
+    getAuthorizations(order: Order): Promise<Authorization[]>;
+    deactivateAuthorization(authz: Authorization): Promise<Authorization>;
+    getChallengeKeyAuthorization(challenge: rfc8555.Challenge): Promise<string>;
+    verifyChallenge(authz: Authorization, challenge: rfc8555.Challenge): Promise<boolean>;
+    completeChallenge(challenge: rfc8555.Challenge): Promise<rfc8555.Challenge>;
+    waitForValidStatus<T = Order | Authorization | rfc8555.Challenge>(item: T): Promise<T>;
+    getCertificate(order: Order, preferredChain?: string | null): Promise<string>;
+    revokeCertificate(cert: CertificateBuffer | CertificateString, data?: rfc8555.CertificateRevocationRequest): Promise<void>;
+    auto(opts: ClientAutoOptions): Promise<string>;
+}
+
+
+/**
+ * Directory URLs
+ */
+
+export const directory: {
+    letsencrypt: {
+        staging: string,
+        production: string
+    }
+};
+
+
+/**
+ * Crypto
+ */
+
+export interface CertificateDomains {
+    commonName: string;
+    altNames: string[];
+}
+
+export interface CertificateIssuer {
+    commonName: string;
+}
+
+export interface CertificateInfo {
+    issuer: CertificateIssuer;
+    domains: CertificateDomains;
+    notAfter: Date;
+    notBefore: Date;
+}
+
+export interface CsrOptions {
+    keySize?: number;
+    commonName?: string;
+    altNames?: string[];
+    country?: string;
+    state?: string;
+    locality?: string;
+    organization?: string;
+    organizationUnit?: string;
+    emailAddress?: string;
+}
+
+export interface CryptoInterface {
+    createPrivateKey(size?: number): Promise<PrivateKeyBuffer>;
+    createPublicKey(key: PrivateKeyBuffer | PrivateKeyString): Promise<PublicKeyBuffer>;
+    getPemBody(str: string): string;
+    splitPemChain(str: string): string[];
+    getModulus(input: PrivateKeyBuffer | PrivateKeyString | PublicKeyBuffer | PublicKeyString | CertificateBuffer | CertificateString | CsrBuffer | CsrString): Promise<Buffer>;
+    getPublicExponent(input: PrivateKeyBuffer | PrivateKeyString | PublicKeyBuffer | PublicKeyString | CertificateBuffer | CertificateString | CsrBuffer | CsrString): Promise<Buffer>;
+    readCsrDomains(csr: CsrBuffer | CsrString): Promise<CertificateDomains>;
+    readCertificateInfo(cert: CertificateBuffer | CertificateString): Promise<CertificateInfo>;
+    createCsr(data: CsrOptions, key?: PrivateKeyBuffer | PrivateKeyString): Promise<[PrivateKeyBuffer, CsrBuffer]>;
+}
+
+export const forge: CryptoInterface;
+
+
+/**
+ * Axios
+ */
+
+export const axios: AxiosInstance;

package/types/rfc8555.d.ts

@@ -1,127 +1,127 @@
-/**
- * Account
- *
- * https://tools.ietf.org/html/rfc8555#section-7.1.2
- * https://tools.ietf.org/html/rfc8555#section-7.3
- * https://tools.ietf.org/html/rfc8555#section-7.3.2
- */
-
-export interface Account {
-    status: 'valid' | 'deactivated' | 'revoked';
-    orders: string;
-    contact?: string[];
-    termsOfServiceAgreed?: boolean;
-    externalAccountBinding?: object;
-}
-
-export interface AccountCreateRequest {
-    contact?: string[];
-    termsOfServiceAgreed?: boolean;
-    onlyReturnExisting?: boolean;
-    externalAccountBinding?: object;
-}
-
-export interface AccountUpdateRequest {
-    status?: string;
-    contact?: string[];
-    termsOfServiceAgreed?: boolean;
-}
-
-
-/**
- * Order
- *
- * https://tools.ietf.org/html/rfc8555#section-7.1.3
- * https://tools.ietf.org/html/rfc8555#section-7.4
- */
-
-export interface Order {
-    status: 'pending' | 'ready' | 'processing' | 'valid' | 'invalid';
-    identifiers: Identifier[];
-    authorizations: string[];
-    finalize: string;
-    expires?: string;
-    notBefore?: string;
-    notAfter?: string;
-    error?: object;
-    certificate?: string;
-}
-
-export interface OrderCreateRequest {
-    identifiers: Identifier[];
-    notBefore?: string;
-    notAfter?: string;
-}
-
-
-/**
- * Authorization
- *
- * https://tools.ietf.org/html/rfc8555#section-7.1.4
- */
-
-export interface Authorization {
-    identifier: Identifier;
-    status: 'pending' | 'valid' | 'invalid' | 'deactivated' | 'expired' | 'revoked';
-    challenges: Challenge[];
-    expires?: string;
-    wildcard?: boolean;
-}
-
-export interface Identifier {
-    type: string;
-    value: string;
-}
-
-
-/**
- * Challenge
- *
- * https://tools.ietf.org/html/rfc8555#section-8
- * https://tools.ietf.org/html/rfc8555#section-8.3
- * https://tools.ietf.org/html/rfc8555#section-8.4
- */
-
-export interface ChallengeAbstract {
-    type: string;
-    url: string;
-    status: 'pending' | 'processing' | 'valid' | 'invalid';
-    validated?: string;
-    error?: object;
-}
-
-export interface HttpChallenge extends ChallengeAbstract {
-    type: 'http-01';
-    token: string;
-}
-
-export interface DnsChallenge extends ChallengeAbstract {
-    type: 'dns-01';
-    token: string;
-}
-
-export type Challenge = HttpChallenge | DnsChallenge;
-
-
-/**
- * Certificate
- *
- * https://tools.ietf.org/html/rfc8555#section-7.6
- */
-
-export enum CertificateRevocationReason {
-    Unspecified = 0,
-    KeyCompromise = 1,
-    CACompromise = 2,
-    AffiliationChanged = 3,
-    Superseded = 4,
-    CessationOfOperation = 5,
-    CertificateHold = 6,
-    RemoveFromCRL = 8,
-    PrivilegeWithdrawn = 9,
-    AACompromise = 10,
-}
-
-export interface CertificateRevocationRequest {
-    reason?: CertificateRevocationReason;
-}
+/**
+ * Account
+ *
+ * https://tools.ietf.org/html/rfc8555#section-7.1.2
+ * https://tools.ietf.org/html/rfc8555#section-7.3
+ * https://tools.ietf.org/html/rfc8555#section-7.3.2
+ */
+
+export interface Account {
+    status: 'valid' | 'deactivated' | 'revoked';
+    orders: string;
+    contact?: string[];
+    termsOfServiceAgreed?: boolean;
+    externalAccountBinding?: object;
+}
+
+export interface AccountCreateRequest {
+    contact?: string[];
+    termsOfServiceAgreed?: boolean;
+    onlyReturnExisting?: boolean;
+    externalAccountBinding?: object;
+}
+
+export interface AccountUpdateRequest {
+    status?: string;
+    contact?: string[];
+    termsOfServiceAgreed?: boolean;
+}
+
+
+/**
+ * Order
+ *
+ * https://tools.ietf.org/html/rfc8555#section-7.1.3
+ * https://tools.ietf.org/html/rfc8555#section-7.4
+ */
+
+export interface Order {
+    status: 'pending' | 'ready' | 'processing' | 'valid' | 'invalid';
+    identifiers: Identifier[];
+    authorizations: string[];
+    finalize: string;
+    expires?: string;
+    notBefore?: string;
+    notAfter?: string;
+    error?: object;
+    certificate?: string;
+}
+
+export interface OrderCreateRequest {
+    identifiers: Identifier[];
+    notBefore?: string;
+    notAfter?: string;
+}
+
+
+/**
+ * Authorization
+ *
+ * https://tools.ietf.org/html/rfc8555#section-7.1.4
+ */
+
+export interface Authorization {
+    identifier: Identifier;
+    status: 'pending' | 'valid' | 'invalid' | 'deactivated' | 'expired' | 'revoked';
+    challenges: Challenge[];
+    expires?: string;
+    wildcard?: boolean;
+}
+
+export interface Identifier {
+    type: string;
+    value: string;
+}
+
+
+/**
+ * Challenge
+ *
+ * https://tools.ietf.org/html/rfc8555#section-8
+ * https://tools.ietf.org/html/rfc8555#section-8.3
+ * https://tools.ietf.org/html/rfc8555#section-8.4
+ */
+
+export interface ChallengeAbstract {
+    type: string;
+    url: string;
+    status: 'pending' | 'processing' | 'valid' | 'invalid';
+    validated?: string;
+    error?: object;
+}
+
+export interface HttpChallenge extends ChallengeAbstract {
+    type: 'http-01';
+    token: string;
+}
+
+export interface DnsChallenge extends ChallengeAbstract {
+    type: 'dns-01';
+    token: string;
+}
+
+export type Challenge = HttpChallenge | DnsChallenge;
+
+
+/**
+ * Certificate
+ *
+ * https://tools.ietf.org/html/rfc8555#section-7.6
+ */
+
+export enum CertificateRevocationReason {
+    Unspecified = 0,
+    KeyCompromise = 1,
+    CACompromise = 2,
+    AffiliationChanged = 3,
+    Superseded = 4,
+    CessationOfOperation = 5,
+    CertificateHold = 6,
+    RemoveFromCRL = 8,
+    PrivilegeWithdrawn = 9,
+    AACompromise = 10,
+}
+
+export interface CertificateRevocationRequest {
+    reason?: CertificateRevocationReason;
+}

package/types/test.ts

@@ -1,70 +1,70 @@
-/**
- * acme-client type definition tests
- */
-
-import * as acme from 'acme-client';
-
-
-(async () => {
-    /* Client */
-    const accountKey = await acme.forge.createPrivateKey();
-
-    const client = new acme.Client({
-        accountKey,
-        directoryUrl: acme.directory.letsencrypt.staging
-    });
-
-    /* Account */
-    await client.createAccount({
-        termsOfServiceAgreed: true,
-        contact: ['mailto:test@example.com']
-    });
-
-    /* Order */
-    const order = await client.createOrder({
-        identifiers: [
-            { type: 'dns', value: 'example.com' },
-            { type: 'dns', value: '*.example.com' },
-        ]
-    });
-
-    await client.getOrder(order);
-
-    /* Authorizations / Challenges */
-    const authorizations = await client.getAuthorizations(order);
-    const authorization = authorizations[0];
-    const challenge = authorization.challenges[0];
-
-    await client.getChallengeKeyAuthorization(challenge);
-    await client.verifyChallenge(authorization, challenge);
-    await client.completeChallenge(challenge);
-    await client.waitForValidStatus(challenge);
-
-    /* Finalize */
-    const [certKey, certCsr] = await acme.forge.createCsr({
-        commonName: 'example.com',
-        altNames: ['example.com', '*.example.com']
-    });
-
-    await client.finalizeOrder(order, certCsr);
-    await client.getCertificate(order);
-    await client.getCertificate(order, 'DST Root CA X3');
-
-    /* Auto */
-    await client.auto({
-        csr: certCsr,
-        challengeCreateFn: async (authz, challenge, keyAuthorization) => {},
-        challengeRemoveFn: async (authz, challenge, keyAuthorization) => {}
-    });
-
-    await client.auto({
-        csr: certCsr,
-        email: 'test@example.com',
-        termsOfServiceAgreed: false,
-        skipChallengeVerification: false,
-        challengePriority: ['http-01', 'dns-01'],
-        preferredChain: 'DST Root CA X3',
-        challengeCreateFn: async (authz, challenge, keyAuthorization) => {},
-        challengeRemoveFn: async (authz, challenge, keyAuthorization) => {}
-    });
-})();
+/**
+ * acme-client type definition tests
+ */
+
+import * as acme from 'acme-client';
+
+
+(async () => {
+    /* Client */
+    const accountKey = await acme.forge.createPrivateKey();
+
+    const client = new acme.Client({
+        accountKey,
+        directoryUrl: acme.directory.letsencrypt.staging
+    });
+
+    /* Account */
+    await client.createAccount({
+        termsOfServiceAgreed: true,
+        contact: ['mailto:test@example.com']
+    });
+
+    /* Order */
+    const order = await client.createOrder({
+        identifiers: [
+            { type: 'dns', value: 'example.com' },
+            { type: 'dns', value: '*.example.com' },
+        ]
+    });
+
+    await client.getOrder(order);
+
+    /* Authorizations / Challenges */
+    const authorizations = await client.getAuthorizations(order);
+    const authorization = authorizations[0];
+    const challenge = authorization.challenges[0];
+
+    await client.getChallengeKeyAuthorization(challenge);
+    await client.verifyChallenge(authorization, challenge);
+    await client.completeChallenge(challenge);
+    await client.waitForValidStatus(challenge);
+
+    /* Finalize */
+    const [certKey, certCsr] = await acme.forge.createCsr({
+        commonName: 'example.com',
+        altNames: ['example.com', '*.example.com']
+    });
+
+    await client.finalizeOrder(order, certCsr);
+    await client.getCertificate(order);
+    await client.getCertificate(order, 'DST Root CA X3');
+
+    /* Auto */
+    await client.auto({
+        csr: certCsr,
+        challengeCreateFn: async (authz, challenge, keyAuthorization) => {},
+        challengeRemoveFn: async (authz, challenge, keyAuthorization) => {}
+    });
+
+    await client.auto({
+        csr: certCsr,
+        email: 'test@example.com',
+        termsOfServiceAgreed: false,
+        skipChallengeVerification: false,
+        challengePriority: ['http-01', 'dns-01'],
+        preferredChain: 'DST Root CA X3',
+        challengeCreateFn: async (authz, challenge, keyAuthorization) => {},
+        challengeRemoveFn: async (authz, challenge, keyAuthorization) => {}
+    });
+})();