X-Git-Url: https://git.squeep.com/?a=blobdiff_plain;f=lib%2Fcommunication.js;h=46ef89e2642ff206207fce8783052d1ea9fee2a5;hb=HEAD;hp=9446b0013483cfbfc701746345038a83e6f85930;hpb=9a3674ec0ab8d8d8afe2d75dabf5ef1807db2d8b;p=squeep-indieauth-helper diff --git a/lib/communication.js b/lib/communication.js index 9446b00..c1c1128 100644 --- a/lib/communication.js +++ b/lib/communication.js @@ -4,11 +4,11 @@ const { mf2 } = require('microformats-parser'); const { parse: parseLinkHeader } = require('@squeep/web-linking'); const { Iconv } = require('iconv'); const { version: packageVersion, name: packageName } = require('../package.json'); -const { randomBytes, createHash } = require('crypto'); -const { promisify } = require('util'); +const { randomBytes, createHash } = require('node:crypto'); +const { promisify } = require('node:util'); const randomBytesAsync = promisify(randomBytes); const { Address4, Address6 } = require('ip-address'); -const dns = require('dns'); +const dns = require('node:dns'); const common = require('./common'); const Enum = require('./enum'); const { Microformat2: { Relation: MF2Rel } } = Enum; @@ -23,15 +23,21 @@ const loopback4 = new Address4('127.0.0.0/8'); const scopeSplitRE = / +/; const utf8CharsetRE = /utf-*8/i; +/** + * @typedef {object} ConsoleLike + * @property {Function } debug debug log function + * @property {Function } error error log function + */ + class Communication { /** - * @param {Console} logger - * @param {Object} options - * @param {Number=} options.timeout - * @param {Object=} options.userAgent - * @param {String=} options.userAgent.product - * @param {String=} options.userAgent.version - * @param {String=} options.userAgent.implementation + * @param {ConsoleLike} logger logger + * @param {object} options options + * @param {number=} options.timeout request timeout + * @param {object=} options.userAgent user agent object + * @param {string=} options.userAgent.product user agent product + * @param {string=} options.userAgent.version user agent version + * @param {string=} options.userAgent.implementation user agent implementation */ constructor(logger, options = {}) { this.logger = logger; @@ -47,11 +53,13 @@ class Communication { /** * Do a little dance to support this ESM client. + * @param {...any} args request args + * @returns {Promise} response */ async _init(...args) { if (!this.Got) { // For some reason eslint is confused about import being supported here. - // eslint-disable-next-line + this.Got = await import('got'); this.got = this.Got.got.extend({ headers: { @@ -76,8 +84,8 @@ class Communication { /** * Take notes on transient retries. - * @param {*} error - * @param {*} retryCount + * @param {*} error error + * @param {*} retryCount retry count */ _onRetry(error, retryCount) { const _scope = _fileScope('_onRetry'); @@ -85,10 +93,12 @@ class Communication { } + /** + * @typedef {string|Buffer|DataView} BinaryLike /** * Encode hashed verifier data for PKCE. - * @param {BinaryLike} verifier - * @returns {String} + * @param {BinaryLike} verifier verifier + * @returns {string} challenge */ static _challengeFromVerifier(verifier) { const hash = createHash('sha256'); @@ -99,14 +109,14 @@ class Communication { /** * @typedef PKCEData - * @property {String} codeChallengeMethod - * @property {String} codeVerifier - * @property {String} codeChallenge + * @property {string} codeChallengeMethod challenge method + * @property {string} codeVerifier code verifier + * @property {string} codeChallenge code challenge */ /** * Create a code verifier and its challenge. - * @param {Number} length of verifier string, between 43 and 128 - * @returns {Promise} + * @param {number} length of verifier string, between 43 and 128 + * @returns {Promise} data */ static async generatePKCE(length = 128) { if (length < 43 || length > 128) { @@ -129,10 +139,10 @@ class Communication { /** * Check a challenge with a verifier. - * @param {String} codeChallenge - * @param {String} codeVerifier - * @param {String} codeChallengeMethod - * @returns {Boolean} + * @param {string} codeChallenge challenge + * @param {string} codeVerifier verifier + * @param {string} codeChallengeMethod method + * @returns {boolean} is valid */ static verifyChallenge(codeChallenge, codeVerifier, codeChallengeMethod) { switch (codeChallengeMethod) { @@ -150,11 +160,11 @@ class Communication { /** * Assemble a suitable User-Agent value. - * @param {Object} userAgentConfig - * @param {String=} userAgentConfig.product - * @param {String=} userAgentConfig.version - * @param {String=} userAgentConfig.implementation - * @returns {String} + * @param {object} userAgentConfig user agent object + * @param {string=} userAgentConfig.product product + * @param {string=} userAgentConfig.version version + * @param {string=} userAgentConfig.implementation implementation + * @returns {string} UA string */ static _userAgentString(userAgentConfig) { // eslint-disable-next-line security/detect-object-injection @@ -172,8 +182,8 @@ class Communication { /** * Isolate the base of a url. * mf2 parser needs this so that relative links can be made absolute. - * @param {URL} urlObj - * @returns {String} + * @param {URL} urlObj url + * @returns {string} url base */ static _baseUrlString(urlObj) { const baseUrl = new URL(urlObj); @@ -185,16 +195,20 @@ class Communication { } + /** + * @typedef {object} ParsedContentType + * @property {string} mediaType media type + * @property {object} params other parameters + */ /** * Convert a Content-Type string to normalized components. * RFC7231 §3.1.1 * N.B. this ill-named non-parsing implementation will not work * if a parameter value for some reason includes a ; or = within * a quoted-string. - * @param {String} contentTypeHeader - * @returns {Object} contentType - * @returns {String} contentType.mediaType - * @returns {Object} contentType.params + * @param {string} contentTypeHeader content-type header value + * @param {string} defaultContentType default type if none present + * @returns {ParsedContentType} contentType */ static _parseContentType(contentTypeHeader, defaultContentType = Enum.ContentType.ApplicationOctetStream) { const [ mediaType, ...params ] = (contentTypeHeader || '').split(/ *; */); @@ -212,9 +226,9 @@ class Communication { /** * Parse and add any header link relations from response to microformat data. - * @param {Object} microformat - * @param {Object} response - * @param {Object} response.headers + * @param {object} microformat microformat + * @param {object} response response + * @param {object} response.headers response headers */ _mergeLinkHeader(microformat, response) { const _scope = _fileScope('_mergeLinkHeader'); @@ -266,8 +280,8 @@ class Communication { /** * Retrieve and parse microformat data from url. * N.B. this absorbs any errors! - * @param {URL} urlObj - * @returns {Promise} + * @param {URL} urlObj url + * @returns {Promise} microformat */ async fetchMicroformat(urlObj) { const _scope = _fileScope('fetchMicroformat'); @@ -330,8 +344,8 @@ class Communication { /** * Retrieve and parse JSON. * N.B. this absorbs any errors! - * @param {URL} urlObj - * @returns {Promise} + * @param {URL} urlObj url + * @returns {Promise} parsed json */ async fetchJSON(urlObj) { const _scope = _fileScope('fetchJSON'); @@ -361,8 +375,8 @@ class Communication { /** * Validate a url has a specific schema. - * @param {URL} urlObj - * @param {String[]} validSchemes + * @param {URL} urlObj url + * @param {string[]} validSchemes url schemes */ static _urlValidScheme(urlObj, validSchemes = ['http:', 'https:']) { if (!validSchemes.includes(urlObj.protocol)) { @@ -373,8 +387,8 @@ class Communication { /** * Validate a url does not include some components. - * @param {URL} urlObj - * @param {String[]} disallowed + * @param {URL} urlObj url + * @param {string[]} disallowed component names */ static _urlPartsDisallowed(urlObj, disallowed) { disallowed.forEach((part) => { @@ -387,7 +401,7 @@ class Communication { /** * Validate a url does not have relative path. - * @param {String} url + * @param {string} url url */ static _urlPathNoDots(url) { if (noDotPathRE.test(url)) { @@ -399,9 +413,9 @@ class Communication { /** * Validate a url does not have a hostname which is an ip address. * N.B. Sets isLoopback on urlObj - * @param {URL} urlObj - * @param {Boolean} allowLoopback - * @param {Boolean} resolveHostname + * @param {URL} urlObj url + * @param {boolean} allowLoopback allow loopback ip + * @param {boolean} resolveHostname resolve hostname for checks * @returns {Promise} */ static async _urlNamedHost(urlObj, allowLoopback, resolveHostname) { @@ -420,7 +434,7 @@ class Communication { address = new Address4(urlObj.hostname); /* Succeeded parsing as ipv4, reject unless loopback */ urlObj.isLoopback = address.isInSubnet(loopback4); - } catch (e) { + } catch (e) { // eslint-disable-line no-unused-vars /* Did not parse as ip, carry on */ } } @@ -489,11 +503,11 @@ class Communication { /** * Ensure a url meets the requirements to be a profile uri. - * @param {String} url - * @param {Object} validationOptions - * @param {Boolean=} validationOptions.allowLoopback default is false, following spec - * @param {Boolean=} validationOptions.resolveHostname default is false, following spec - * @returns {Promise} + * @param {string} url url + * @param {object} validationOptions options + * @param {boolean=} validationOptions.allowLoopback default is false, following spec + * @param {boolean=} validationOptions.resolveHostname default is false, following spec + * @returns {Promise} validated url */ async validateProfile(url, validationOptions) { const _scope = _fileScope('validateProfile'); @@ -531,11 +545,11 @@ class Communication { /** * Ensure a url meets the requirements to be a client identifier. * Sets 'isLoopback' on returned URL object to true if hostname is - or resolves to - a loopback ip. - * @param {String} url - * @param {Object} validationOptions - * @param {Boolean=} validationOptions.allowLoopback default is true, following spec - * @param {Boolean=} validationOptions.resolveHostname default is true, following spec - * @returns {Promise} + * @param {string} url url + * @param {object} validationOptions options + * @param {boolean=} validationOptions.allowLoopback default is true, following spec + * @param {boolean=} validationOptions.resolveHostname default is true, following spec + * @returns {Promise} validated client url */ async validateClientIdentifier(url, validationOptions) { const _scope = _fileScope('validateClientIdentifier'); @@ -571,14 +585,19 @@ class Communication { /** - * @typedef {Object} ClientIdentifierData - * @property {Object} rels - keyed by relation to array of uris - * @property {HAppData[]} items + * @typedef {object} HAppData + * @property {string[]=} type list of item types + * @property {object=} properties map of item properties + */ + /** + * @typedef {object} ClientIdentifierData + * @property {object} rels keyed by relation to array of uris + * @property {HAppData[]} items h-app data */ /** * Retrieve and parse client identifier endpoint data. * N.B. Assumes urlObj has passed validateClientIdentifier. - * @param {URL} urlObj + * @param {URL} urlObj url * @returns {Promise} mf2 data filtered for h-app items, or undefined if url could not be fetched */ async fetchClientIdentifier(urlObj) { @@ -610,7 +629,7 @@ class Communication { if (hUrl.href === urlObj.href) { urlMatched = true; } - } catch (e) { /**/ } + } catch (e) { /**/ } // eslint-disable-line no-unused-vars }); } return urlMatched; @@ -620,39 +639,39 @@ class Communication { /** - * @typedef {Object} Metadata - * @property {String} issuer - * @property {String} authorizationEndpoint - * @property {String} tokenEndpoint - * @property {String} ticketEndpoint - * @property {String} introspectionEndpoint - * @property {String} introspectionEndpointAuthMethodsSupported - * @property {String} revocationEndpoint - * @property {String} revocationEndpointAuthMethodsSupported - * @property {String} scopesSupported - * @property {String} responseTypesSupported - * @property {String} grantTypesSupported - * @property {String} serviceDocumentation - * @property {String} codeChallengeMethodsSupported - * @property {String} authorizationResponseIssParameterSupported - * @property {String} userinfoEndpoint + * @typedef {object} Metadata + * @property {string} issuer issuer + * @property {string} authorizationEndpoint authorization endpoint + * @property {string} tokenEndpoint token endpoint + * @property {string} ticketEndpoint ticket endpoint + * @property {string} introspectionEndpoint introspection endpoint + * @property {string} introspectionEndpointAuthMethodsSupported auth methods + * @property {string} revocationEndpoint revocation endpoint + * @property {string} revocationEndpointAuthMethodsSupported auth methods + * @property {string} scopesSupported scopes + * @property {string} responseTypesSupported response types + * @property {string} grantTypesSupported grant types + * @property {string} serviceDocumentation service documentation reference + * @property {string} codeChallengeMethodsSupported code challenge methods + * @property {string} authorizationResponseIssParameterSupported iss parameter supported + * @property {string} userinfoEndpoint endpoint */ /** * @typedef ProfileData - * @property {String} name - * @property {String} photo - * @property {String} url - * @property {String} email - * @property {String} authorizationEndpoint - deprecated, backwards compatibility for 20201126 spec - * @property {String} tokenEndpoint - deprecated, backwards compatibility for 20201126 spec - * @property {String} indieauthMetadata authorization server metadata endpoint - * @property {Metadata} metadata - authorization server metadata for profile + * @property {string} name name + * @property {string} photo photo + * @property {string} url url + * @property {string} email email + * @property {string} authorizationEndpoint deprecated, backwards compatibility for 20201126 spec + * @property {string} tokenEndpoint deprecated, backwards compatibility for 20201126 spec + * @property {string} indieauthMetadata authorization server metadata endpoint + * @property {Metadata} metadata authorization server metadata for profile */ /** * Fetch the relevant microformat data from profile url h-card information, * and authorization server metadata. * N.B. Assumes urlObj has passed validateProfile - * @param {URL} urlObj + * @param {URL} urlObj valid profile url * @returns {Promise} mf2 data filtered for select fields from h-card */ async fetchProfile(urlObj) { @@ -706,7 +725,7 @@ class Communication { let mdURL; try { mdURL = new URL(profile.indieauthMetadata); - } catch (e) /* istanbul ignore next */ { + } catch (e) /* istanbul ignore next */ { // eslint-disable-line no-unused-vars this.logger.error(_scope, 'invalid authorization server metadata url', { profile }); } /* istanbul ignore else */ @@ -728,8 +747,8 @@ class Communication { /** * Fetch the server metadata from an authorization server's metadata endpoint. - * @param {URL} metadataUrl - * @returns {Promise} + * @param {URL} metadataUrl url + * @returns {Promise} metadata */ async fetchMetadata(metadataUrl) { const metadataResponse = await this.fetchJSON(metadataUrl); @@ -766,12 +785,12 @@ class Communication { /** * POST to the auth endpoint, to redeem a code for a profile or token. * N.B. this absorbs any errors! - * @param {URL} urlObj - * @param {String} code - * @param {String} codeVerifier - * @param {String} clientId - * @param {String} redirectURI - * @returns {Promise} + * @param {URL} urlObj url + * @param {string} code code + * @param {string} codeVerifier verifier + * @param {string} clientId client id + * @param {string} redirectURI uri + * @returns {Promise} response */ async redeemCode(urlObj, code, codeVerifier, clientId, redirectURI) { const _scope = _fileScope('redeemCode'); @@ -805,12 +824,12 @@ class Communication { /** * Deprecated method name alias. * @see redeemCode - * @param {URL} urlObj - * @param {String} code - * @param {Strin} codeVerifier - * @param {String} clientId - * @param {String} redirectURI - * @returns {Promise} + * @param {URL} urlObj url + * @param {string} code code + * @param {string} codeVerifier verifier + * @param {string} clientId client id + * @param {string} redirectURI uri + * @returns {Promise} response */ async redeemProfileCode(urlObj, code, codeVerifier, clientId, redirectURI) { return this.redeemCode(urlObj, code, codeVerifier, clientId, redirectURI); @@ -819,10 +838,10 @@ class Communication { /** * Verify a token with an IdP endpoint, using the Authorization header supplied. - * @param {URL} introspectionUrlObj - * @param {String} authorizationHeader - * @param {String} token - * @returns {Promise} + * @param {URL} introspectionUrlObj url + * @param {string} authorizationHeader authorization + * @param {string} token token + * @returns {Promise} response */ async introspectToken(introspectionUrlObj, authorizationHeader, token) { const _scope = _fileScope('introspectToken'); @@ -879,12 +898,12 @@ class Communication { /** * Attempt to deliver a ticket to an endpoint. * N.B. does not absorb errors - * @param {URL} ticketEndpointUrlObj - * @param {URL} resourceUrlObj - * @param {URL} subjectUrlObj - * @param {URL=} issuerUrlObj - * @param {String} ticket - * @returns {Promise} + * @param {URL} ticketEndpointUrlObj url ticket endpoint url + * @param {URL} resourceUrlObj url resource url + * @param {URL} subjectUrlObj url subject url + * @param {string} ticket ticket + * @param {URL=} issuerUrlObj issuer url + * @returns {Promise} response */ async deliverTicket(ticketEndpointUrlObj, resourceUrlObj, subjectUrlObj, ticket, issuerUrlObj) { const _scope = _fileScope('deliverTicket'); @@ -912,8 +931,8 @@ class Communication { /** * Attempt to fetch some link relations from a url. - * @param {URL} urlObj - * @returns {Promise} + * @param {URL} urlObj url + * @returns {Promise} data */ async _fetchMetadataOrTokenEndpoint(urlObj) { const _scope = _fileScope('_fetchMetadataOrTokenEndpoint'); @@ -925,7 +944,7 @@ class Communication { if (metadataRel) { try { metadataUrl = new URL(metadataRel); - } catch (e) { + } catch (e) { // eslint-disable-line no-unused-vars this.logger.debug(_scope, 'invalid metadata rel url', { url: urlObj.href, metadataRel }); } } @@ -935,7 +954,7 @@ class Communication { if (tokenRel) { try { tokenUrl = new URL(tokenRel); - } catch (e) { + } catch (e) { // eslint-disable-line no-unused-vars this.logger.debug(_scope, 'invalid token rel url', { url: urlObj.href, tokenRel }); } } @@ -948,10 +967,10 @@ class Communication { /** * Attempt to redeem a ticket for a token. * N.B. does not absorb errors - * @property {String} ticket - * @property {URL} resourceUrlObj - * @property {URL=} issuerUrlObj - * @returns {Promise} response body + * @param {string} ticket ticket + * @param {URL} resourceUrlObj resource url + * @param {URL=} issuerUrlObj issuer url + * @returns {Promise} response body */ async redeemTicket(ticket, resourceUrlObj, issuerUrlObj) { const _scope = _fileScope('redeemTicket'); @@ -971,7 +990,7 @@ class Communication { const metadata = await this.fetchMetadata(metadataUrl); try { tokenUrl = new URL(metadata?.tokenEndpoint); - } catch (e) { + } catch (e) { // eslint-disable-line no-unused-vars this.logger.debug(_scope, 'invalid token endpoint url from metadata', { resourceUrl: resourceUrlObj.href, issuerUrl: issuerUrlObj.href, tokenEndpoint: metadata?.tokenEndpoint }); } }