2019-10-08 10:51:15 +00:00
'use strict' ;
2019-06-03 09:12:11 +00:00
/*global Promise*/
2019-10-08 10:51:15 +00:00
require ( './lib/compat.js' ) ;
2015-12-11 14:22:46 +00:00
2019-04-08 07:56:37 +00:00
// I hate this code so much.
// Soooo many shims for backwards compatibility (some stuff dating back to v1)
// v3 will be a clean break and I'll delete half of the code...
2016-08-16 00:50:55 +00:00
var DAY = 24 * 60 * 60 * 1000 ;
//var MIN = 60 * 1000;
2019-10-08 10:51:15 +00:00
var ACME = require ( 'acme-v2/compat' ) . ACME ;
var pkg = require ( './package.json' ) ;
var util = require ( 'util' ) ;
2019-06-03 09:12:11 +00:00
2018-07-04 08:13:11 +00:00
function promisifyAllSelf ( obj ) {
2019-06-03 09:12:11 +00:00
if ( obj . _ _promisified ) {
return obj ;
}
Object . keys ( obj ) . forEach ( function ( key ) {
2019-10-08 10:51:15 +00:00
if ( 'function' === typeof obj [ key ] && ! /Async$/ . test ( key ) ) {
obj [ key + 'Async' ] = util . promisify ( obj [ key ] ) ;
2019-06-03 09:12:11 +00:00
}
} ) ;
obj . _ _promisified = true ;
return obj ;
2018-07-04 08:13:11 +00:00
}
2019-04-05 08:29:21 +00:00
function promisifyAllStore ( obj ) {
2019-06-03 09:12:11 +00:00
Object . keys ( obj ) . forEach ( function ( key ) {
2019-10-08 10:51:15 +00:00
if ( 'function' !== typeof obj [ key ] || /Async$/ . test ( key ) ) {
2019-06-03 09:12:11 +00:00
return ;
}
var p ;
if ( 0 === obj [ key ] . length || 1 === obj [ key ] . length ) {
// wrap just in case it's synchronous (or improperly throws)
p = function ( opts ) {
return Promise . resolve ( ) . then ( function ( ) {
return obj [ key ] ( opts ) ;
} ) ;
} ;
} else {
p = util . promisify ( obj [ key ] ) ;
}
// internal backwards compat
2019-10-08 10:51:15 +00:00
obj [ key + 'Async' ] = p ;
2019-06-03 09:12:11 +00:00
} ) ;
obj . _ _promisified = true ;
return obj ;
2019-04-05 08:29:21 +00:00
}
2015-12-12 15:05:45 +00:00
2018-05-15 22:01:09 +00:00
var Greenlock = module . exports ;
Greenlock . Greenlock = Greenlock ;
Greenlock . LE = Greenlock ;
2016-08-05 22:50:42 +00:00
// in-process cache, shared between all instances
var ipc = { } ;
2016-08-04 22:49:35 +00:00
2016-08-25 20:09:23 +00:00
function _log ( debug ) {
2019-06-03 09:12:11 +00:00
if ( debug ) {
var args = Array . prototype . slice . call ( arguments ) ;
args . shift ( ) ;
2019-10-08 10:51:15 +00:00
args . unshift ( '[gl/index.js]' ) ;
2019-06-03 09:12:11 +00:00
console . log . apply ( console , args ) ;
}
2016-08-25 20:09:23 +00:00
}
2018-05-15 22:01:09 +00:00
Greenlock . defaults = {
2019-10-08 10:51:15 +00:00
productionServerUrl : 'https://acme-v01.api.letsencrypt.org/directory' ,
stagingServerUrl : 'https://acme-staging.api.letsencrypt.org/directory' ,
2016-08-04 22:49:35 +00:00
2019-06-03 09:12:11 +00:00
rsaKeySize : ACME . rsaKeySize || 2048 ,
2019-10-08 10:51:15 +00:00
challengeType : ACME . challengeType || 'http-01' ,
challengeTypes : ACME . challengeTypes || [ 'http-01' , 'dns-01' ] ,
2016-08-05 22:21:10 +00:00
2019-06-03 09:12:11 +00:00
acmeChallengePrefix : ACME . acmeChallengePrefix
2016-02-13 02:33:50 +00:00
} ;
2015-12-20 10:41:17 +00:00
2015-12-16 09:11:31 +00:00
// backwards compat
2019-06-03 09:12:11 +00:00
Object . keys ( Greenlock . defaults ) . forEach ( function ( key ) {
Greenlock [ key ] = Greenlock . defaults [ key ] ;
2016-08-04 22:49:35 +00:00
} ) ;
2015-12-13 01:04:12 +00:00
2016-08-05 22:21:10 +00:00
// show all possible options
2016-08-05 22:16:29 +00:00
var u ; // undefined
2018-05-15 22:01:09 +00:00
Greenlock . _undefined = {
2019-06-03 09:12:11 +00:00
acme : u ,
store : u ,
//, challenge: u
challenges : u ,
sni : u ,
tlsOptions : u ,
register : u ,
check : u ,
renewWithin : u , // le-auto-sni and core
//, renewBy: u // le-auto-sni
acmeChallengePrefix : u ,
rsaKeySize : u ,
challengeType : u ,
server : u ,
version : u ,
agreeToTerms : u ,
_ipc : u ,
duplicate : u ,
_acmeUrls : u
2016-08-05 22:16:29 +00:00
} ;
2019-06-03 09:12:11 +00:00
Greenlock . _undefine = function ( gl ) {
Object . keys ( Greenlock . _undefined ) . forEach ( function ( key ) {
if ( ! ( key in gl ) ) {
gl [ key ] = u ;
}
} ) ;
return gl ;
2016-08-05 22:16:29 +00:00
} ;
2019-06-03 09:12:11 +00:00
Greenlock . create = function ( gl ) {
if ( ! gl . store ) {
console . warn (
"Deprecation Notice: You're haven't chosen a storage strategy." +
" The old default is 'le-store-certbot', but the new default will be 'greenlock-store-fs'." +
" Please `npm install greenlock-store-fs@3` and explicitly set `{ store: require('greenlock-store-fs') }`."
) ;
2019-10-08 10:51:15 +00:00
gl . store = require ( 'le-store-certbot' ) . create ( {
2019-06-03 09:12:11 +00:00
debug : gl . debug ,
configDir : gl . configDir ,
logsDir : gl . logsDir ,
webrootPath : gl . webrootPath
} ) ;
}
2019-10-08 10:51:15 +00:00
gl . core = require ( './lib/core' ) ;
2019-06-03 09:12:11 +00:00
var log = gl . log || _log ;
if ( ! gl . challenges ) {
gl . challenges = { } ;
}
2019-10-08 10:51:15 +00:00
if ( ! gl . challenges [ 'http-01' ] ) {
gl . challenges [ 'http-01' ] = require ( 'le-challenge-fs' ) . create ( {
2019-06-03 09:12:11 +00:00
debug : gl . debug ,
webrootPath : gl . webrootPath
} ) ;
}
2019-10-08 10:51:15 +00:00
if ( ! gl . challenges [ 'dns-01' ] ) {
2019-06-03 09:12:11 +00:00
try {
2019-10-08 10:51:15 +00:00
gl . challenges [ 'dns-01' ] = require ( 'le-challenge-ddns' ) . create ( {
2019-06-03 09:12:11 +00:00
debug : gl . debug
} ) ;
} catch ( e ) {
try {
2019-10-08 10:51:15 +00:00
gl . challenges [ 'dns-01' ] = require ( 'le-challenge-dns' ) . create ( {
2019-06-03 09:12:11 +00:00
debug : gl . debug
} ) ;
} catch ( e ) {
// not yet implemented
}
}
}
gl = Greenlock . _undefine ( gl ) ;
gl . acmeChallengePrefix = Greenlock . acmeChallengePrefix ;
gl . rsaKeySize = gl . rsaKeySize || Greenlock . rsaKeySize ;
gl . challengeType = gl . challengeType || Greenlock . challengeType ;
gl . _ipc = ipc ;
2019-10-08 10:51:15 +00:00
gl . _communityPackage = gl . _communityPackage || 'greenlock.js' ;
if ( 'greenlock.js' === gl . _communityPackage ) {
2019-06-03 09:12:11 +00:00
gl . _communityPackageVersion = pkg . version ;
} else {
gl . _communityPackageVersion =
2019-10-08 10:51:15 +00:00
gl . _communityPackageVersion || 'greenlock.js-' + pkg . version ;
2019-06-03 09:12:11 +00:00
}
gl . agreeToTerms =
gl . agreeToTerms ||
function ( args , agreeCb ) {
agreeCb (
new Error (
"'agreeToTerms' was not supplied to Greenlock and 'agreeTos' was not supplied to Greenlock.register"
)
) ;
} ;
if ( ! gl . renewWithin ) {
gl . renewWithin = 14 * DAY ;
}
// renewBy has a default in le-sni-auto
///////////////////////////
// BEGIN VERSION MADNESS //
///////////////////////////
2019-10-08 10:51:15 +00:00
gl . version = gl . version || 'draft-11' ;
gl . server = gl . server || 'https://acme-v02.api.letsencrypt.org/directory' ;
2019-06-03 09:12:11 +00:00
if ( ! gl . version ) {
//console.warn("Please specify version: 'v01' (Let's Encrypt v1) or 'draft-12' (Let's Encrypt v2 / ACME draft 12)");
2019-10-08 10:51:15 +00:00
console . warn ( '' ) ;
console . warn ( '' ) ;
console . warn ( '' ) ;
console . warn (
'=========================================================='
) ;
console . warn (
'== greenlock.js (v2.2.0+) =='
) ;
console . warn (
'=========================================================='
) ;
console . warn ( '' ) ;
2019-06-03 09:12:11 +00:00
console . warn ( "Please specify 'version' option:" ) ;
2019-10-08 10:51:15 +00:00
console . warn ( '' ) ;
console . warn (
" 'draft-12' for Let's Encrypt v2 and ACME draft 12"
) ;
2019-06-03 09:12:11 +00:00
console . warn ( " ('v02' is an alias of 'draft-12'" ) ;
2019-10-08 10:51:15 +00:00
console . warn ( '' ) ;
console . warn ( 'or' ) ;
console . warn ( '' ) ;
2019-06-03 09:12:11 +00:00
console . warn ( " 'v01' for Let's Encrypt v1 (deprecated)" ) ;
console . warn (
" (also 'npm install --save le-acme-core' as this legacy dependency will soon be removed)"
) ;
2019-10-08 10:51:15 +00:00
console . warn ( '' ) ;
console . warn ( 'This will be required in versions v2.3+' ) ;
console . warn ( '' ) ;
console . warn ( '' ) ;
} else if ( 'v02' === gl . version ) {
gl . version = 'draft-11' ;
} else if ( 'draft-12' === gl . version ) {
gl . version = 'draft-11' ;
} else if ( 'draft-11' === gl . version ) {
2019-06-03 09:12:11 +00:00
// no-op
2019-10-08 10:51:15 +00:00
} else if ( 'v01' !== gl . version ) {
2019-06-03 09:12:11 +00:00
throw new Error ( "Unrecognized version '" + gl . version + "'" ) ;
}
if ( ! gl . server ) {
throw new Error (
"opts.server must specify an ACME directory URL, such as 'https://acme-staging-v02.api.letsencrypt.org/directory'"
) ;
}
2019-10-08 10:51:15 +00:00
if ( 'staging' === gl . server || 'production' === gl . server ) {
if ( 'staging' === gl . server ) {
gl . server = 'https://acme-staging.api.letsencrypt.org/directory' ;
gl . version = 'v01' ;
gl . _deprecatedServerName = 'staging' ;
} else if ( 'production' === gl . server ) {
gl . server = 'https://acme-v01.api.letsencrypt.org/directory' ;
gl . version = 'v01' ;
gl . _deprecatedServerName = 'production' ;
2019-06-03 09:12:11 +00:00
}
2019-10-08 10:51:15 +00:00
console . warn ( '' ) ;
console . warn ( '' ) ;
console . warn ( '=== WARNING ===' ) ;
console . warn ( '' ) ;
2019-06-03 09:12:11 +00:00
console . warn (
"Due to versioning issues the '" +
gl . _deprecatedServerName +
"' option is deprecated."
) ;
2019-10-08 10:51:15 +00:00
console . warn ( 'Please specify the full url and version.' ) ;
console . warn ( '' ) ;
console . warn ( 'For APIs add:' ) ;
2019-06-03 09:12:11 +00:00
console . warn ( '\t, "version": "' + gl . version + '"' ) ;
console . warn ( '\t, "server": "' + gl . server + '"' ) ;
2019-10-08 10:51:15 +00:00
console . warn ( '' ) ;
console . warn ( 'For the CLI add:' ) ;
2019-06-03 09:12:11 +00:00
console . warn ( "\t--acme-url '" + gl . server + "' \\" ) ;
console . warn ( "\t--acme-version '" + gl . version + "' \\" ) ;
2019-10-08 10:51:15 +00:00
console . warn ( '' ) ;
console . warn ( '' ) ;
2019-06-03 09:12:11 +00:00
}
function loadLeV01 ( ) {
2019-10-08 10:51:15 +00:00
console . warn ( '' ) ;
console . warn ( '=== WARNING ===' ) ;
console . warn ( '' ) ;
2019-06-03 09:12:11 +00:00
console . warn ( "Let's Encrypt v1 is deprecated." ) ;
console . warn ( "Please update to Let's Encrypt v2 (ACME draft 12)" ) ;
2019-10-08 10:51:15 +00:00
console . warn ( '' ) ;
2019-06-03 09:12:11 +00:00
try {
2019-10-08 10:51:15 +00:00
return require ( 'le-acme-core' ) . ACME ;
2019-06-03 09:12:11 +00:00
} catch ( e ) {
2019-10-08 10:51:15 +00:00
console . error ( '' ) ;
console . error ( '=== Error (easy-to-fix) ===' ) ;
console . error ( '' ) ;
2019-06-03 09:12:11 +00:00
console . error (
"Hey, this isn't a big deal, but you need to manually add v1 support:"
) ;
2019-10-08 10:51:15 +00:00
console . error ( '' ) ;
console . error ( ' npm install --save le-acme-core' ) ;
console . error ( '' ) ;
2019-06-03 09:12:11 +00:00
console . error (
2019-10-08 10:51:15 +00:00
'Just run that real quick, restart, and everything will work great.'
2019-06-03 09:12:11 +00:00
) ;
2019-10-08 10:51:15 +00:00
console . error ( '' ) ;
console . error ( '' ) ;
2019-06-03 09:12:11 +00:00
process . exit ( e . code || 13 ) ;
}
}
if (
- 1 !==
[
2019-10-08 10:51:15 +00:00
'https://acme-v02.api.letsencrypt.org/directory' ,
'https://acme-staging-v02.api.letsencrypt.org/directory'
2019-06-03 09:12:11 +00:00
] . indexOf ( gl . server )
) {
2019-10-08 10:51:15 +00:00
if ( 'draft-11' !== gl . version ) {
2019-06-03 09:12:11 +00:00
console . warn (
"Detected Let's Encrypt v02 URL. Changing version to draft-12."
) ;
2019-10-08 10:51:15 +00:00
gl . version = 'draft-11' ;
2019-06-03 09:12:11 +00:00
}
} else if (
- 1 !==
[
2019-10-08 10:51:15 +00:00
'https://acme-v01.api.letsencrypt.org/directory' ,
'https://acme-staging.api.letsencrypt.org/directory'
2019-06-03 09:12:11 +00:00
] . indexOf ( gl . server ) ||
2019-10-08 10:51:15 +00:00
'v01' === gl . version
2019-06-03 09:12:11 +00:00
) {
2019-10-08 10:51:15 +00:00
if ( 'v01' !== gl . version ) {
2019-06-03 09:12:11 +00:00
console . warn (
"Detected Let's Encrypt v01 URL (deprecated). Changing version to v01."
) ;
2019-10-08 10:51:15 +00:00
gl . version = 'v01' ;
2019-06-03 09:12:11 +00:00
}
}
2019-10-08 10:51:15 +00:00
if ( 'v01' === gl . version ) {
2019-06-03 09:12:11 +00:00
ACME = loadLeV01 ( ) ;
}
/////////////////////////
// END VERSION MADNESS //
/////////////////////////
gl . acme =
gl . acme ||
ACME . create ( {
debug : gl . debug ,
skipChallengeTest : gl . skipChallengeTest ,
skipDryRun : gl . skipDryRun
} ) ;
if ( gl . acme . create ) {
gl . acme = gl . acme . create ( gl ) ;
}
gl . acme = promisifyAllSelf ( gl . acme ) ;
gl . _acmeOpts =
( gl . acme . getOptions && gl . acme . getOptions ( ) ) || gl . acme . options || { } ;
Object . keys ( gl . _acmeOpts ) . forEach ( function ( key ) {
if ( ! ( key in gl ) ) {
gl [ key ] = gl . _acmeOpts [ key ] ;
}
} ) ;
try {
if ( gl . store . create ) {
gl . store = gl . store . create ( gl ) ;
}
gl . store = promisifyAllSelf ( gl . store ) ;
gl . store . accounts = promisifyAllStore ( gl . store . accounts ) ;
gl . store . certificates = promisifyAllStore ( gl . store . certificates ) ;
gl . _storeOpts =
2019-10-08 10:51:15 +00:00
( gl . store . getOptions && gl . store . getOptions ( ) ) ||
gl . store . options ||
{ } ;
2019-06-03 09:12:11 +00:00
} catch ( e ) {
console . error ( e ) ;
console . error (
2019-10-08 10:51:15 +00:00
'\nPROBABLE CAUSE:\n' +
'\tYour greenlock-store module should have a create function and return { options, accounts, certificates }\n'
2019-06-03 09:12:11 +00:00
) ;
process . exit ( 18 ) ;
return ;
}
Object . keys ( gl . _storeOpts ) . forEach ( function ( key ) {
if ( ! ( key in gl ) ) {
gl [ key ] = gl . _storeOpts [ key ] ;
}
} ) ;
//
// Backwards compat for <= v2.1.7
//
if ( gl . challenge ) {
console . warn (
"Deprecated use of gl.challenge. Use gl.challenges['" +
Greenlock . challengeType +
"'] instead."
) ;
gl . challenges [ gl . challengeType ] = gl . challenge ;
gl . challenge = undefined ;
}
Object . keys ( gl . challenges || { } ) . forEach ( function ( challengeType ) {
var challenger = gl . challenges [ challengeType ] ;
if ( challenger . create ) {
challenger = gl . challenges [ challengeType ] = challenger . create ( gl ) ;
}
2019-10-08 10:51:15 +00:00
challenger = gl . challenges [ challengeType ] = promisifyAllSelf (
challenger
) ;
gl [ '_challengeOpts_' + challengeType ] =
2019-06-03 09:12:11 +00:00
( challenger . getOptions && challenger . getOptions ( ) ) ||
challenger . options ||
{ } ;
2019-10-08 10:51:15 +00:00
Object . keys ( gl [ '_challengeOpts_' + challengeType ] ) . forEach ( function (
key
) {
2019-06-03 09:12:11 +00:00
if ( ! ( key in gl ) ) {
2019-10-08 10:51:15 +00:00
gl [ key ] = gl [ '_challengeOpts_' + challengeType ] [ key ] ;
2019-06-03 09:12:11 +00:00
}
} ) ;
// TODO wrap these here and now with tplCopy?
if ( ! challenger . set || ! [ 5 , 2 , 1 ] . includes ( challenger . set . length ) ) {
throw new Error (
2019-10-08 10:51:15 +00:00
'gl.challenges[' +
2019-06-03 09:12:11 +00:00
challengeType +
2019-10-08 10:51:15 +00:00
'].set receives the wrong number of arguments.' +
' You must define setChallenge as function (opts) { return Promise.resolve(); }'
2019-06-03 09:12:11 +00:00
) ;
}
if ( challenger . get && ! [ 4 , 2 , 1 ] . includes ( challenger . get . length ) ) {
throw new Error (
2019-10-08 10:51:15 +00:00
'gl.challenges[' +
2019-06-03 09:12:11 +00:00
challengeType +
2019-10-08 10:51:15 +00:00
'].get receives the wrong number of arguments.' +
' You must define getChallenge as function (opts) { return Promise.resolve(); }'
2019-06-03 09:12:11 +00:00
) ;
}
2019-10-08 10:51:15 +00:00
if (
! challenger . remove ||
! [ 4 , 2 , 1 ] . includes ( challenger . remove . length )
) {
2019-06-03 09:12:11 +00:00
throw new Error (
2019-10-08 10:51:15 +00:00
'gl.challenges[' +
2019-06-03 09:12:11 +00:00
challengeType +
2019-10-08 10:51:15 +00:00
'].remove receives the wrong number of arguments.' +
' You must define removeChallenge as function (opts) { return Promise.resolve(); }'
2019-06-03 09:12:11 +00:00
) ;
}
/ *
2018-05-15 22:01:09 +00:00
if ( ! gl . _challengeWarn && ( ! challenger . loopback || 4 !== challenger . loopback . length ) ) {
gl . _challengeWarn = true ;
console . warn ( "gl.challenges[" + challengeType + "].loopback should be defined as function (opts, domain, token, cb) { ... } and should prove (by external means) that the ACME server challenge '" + challengeType + "' will succeed" ) ;
2016-10-12 23:25:05 +00:00
}
2018-05-15 22:01:09 +00:00
else if ( ! gl . _challengeWarn && ( ! challenger . test || 5 !== challenger . test . length ) ) {
gl . _challengeWarn = true ;
console . warn ( "gl.challenges[" + challengeType + "].test should be defined as function (opts, domain, token, keyAuthorization, cb) { ... } and should prove (by external means) that the ACME server challenge '" + challengeType + "' will succeed" ) ;
2016-09-21 23:30:47 +00:00
}
2018-04-16 01:28:05 +00:00
* /
2019-06-03 09:12:11 +00:00
} ) ;
gl . sni = gl . sni || null ;
gl . tlsOptions = gl . tlsOptions || gl . httpsOptions || { } ;
// Workaround for https://github.com/nodejs/node/issues/22389
gl . _updateServernames = function ( cert ) {
if ( ! gl . _certnames ) {
gl . _certnames = { } ;
}
// Note: Any given domain could exist on multiple certs
// (especially during renewal where some may be added)
// hence we use a separate object for each domain and list each domain on it
// to get the minimal full set associated with each cert and domain
var allDomains = [ cert . subject ] . concat ( cert . altnames . slice ( 0 ) ) ;
allDomains . forEach ( function ( name ) {
name = name . toLowerCase ( ) ;
if ( ! gl . _certnames [ name ] ) {
gl . _certnames [ name ] = { } ;
}
allDomains . forEach ( function ( name2 ) {
name2 = name2 . toLowerCase ( ) ;
gl . _certnames [ name ] [ name2 ] = true ;
} ) ;
} ) ;
} ;
gl . _checkServername = function ( safeHost , servername ) {
// odd, but acceptable
if ( ! safeHost || ! servername ) {
return true ;
}
if ( safeHost === servername ) {
return true ;
}
// connection established with servername and session is re-used for allowed name
if ( gl . _certnames [ servername ] && gl . _certnames [ servername ] [ safeHost ] ) {
return true ;
}
return false ;
} ;
if ( ! gl . tlsOptions . SNICallback ) {
if ( ! gl . getCertificatesAsync && ! gl . getCertificates ) {
if ( Array . isArray ( gl . approveDomains ) ) {
gl . approvedDomains = gl . approveDomains ;
gl . approveDomains = null ;
}
if ( ! gl . approveDomains ) {
gl . approveDomains = function ( lexOpts , cb ) {
var err ;
var emsg ;
if ( ! gl . email ) {
throw new Error (
2019-10-08 10:51:15 +00:00
'le-sni-auto is not properly configured. Missing email'
2019-06-03 09:12:11 +00:00
) ;
}
if ( ! gl . agreeTos ) {
throw new Error (
2019-10-08 10:51:15 +00:00
'le-sni-auto is not properly configured. Missing agreeTos'
2019-06-03 09:12:11 +00:00
) ;
}
if ( ! /[a-z]/i . test ( lexOpts . domain ) ) {
2019-10-08 10:51:15 +00:00
cb (
new Error (
'le-sni-auto does not allow IP addresses in SNI'
)
) ;
2019-06-03 09:12:11 +00:00
return ;
}
if ( ! Array . isArray ( gl . approvedDomains ) ) {
// The acme-v2 package uses pre-flight test challenges to
// verify that each requested domain is hosted by the server
// these checks are sufficient for most use cases
return cb ( null , lexOpts ) ;
}
if (
lexOpts . domains . every ( function ( domain ) {
return - 1 !== gl . approvedDomains . indexOf ( domain ) ;
} )
) {
// commented this out because people expect to be able to edit the list of domains
// lexOpts.domains = gl.approvedDomains.slice(0);
lexOpts . email = gl . email ;
lexOpts . agreeTos = gl . agreeTos ;
lexOpts . communityMember = gl . communityMember ;
lexOpts . telemetry = gl . telemetry ;
return cb ( null , lexOpts ) ;
}
emsg =
"tls SNI for '" +
2019-10-08 10:51:15 +00:00
lexOpts . domains . join ( ',' ) +
2019-06-03 09:12:11 +00:00
"' rejected: not in list '" +
gl . approvedDomains +
"'" ;
log ( gl . debug , emsg , lexOpts . domains , gl . approvedDomains ) ;
err = new Error ( emsg ) ;
2019-10-08 10:51:15 +00:00
err . code = 'E_REJECT_SNI' ;
2019-06-03 09:12:11 +00:00
cb ( err ) ;
} ;
}
gl . getCertificates = function ( domain , certs , cb ) {
// certs come from current in-memory cache, not lookup
log (
gl . debug ,
2019-10-08 10:51:15 +00:00
'gl.getCertificates called for' ,
2019-06-03 09:12:11 +00:00
domain ,
2019-10-08 10:51:15 +00:00
'with certs for' ,
( certs && certs . altnames ) || 'NONE'
2019-06-03 09:12:11 +00:00
) ;
var opts = {
domain : domain ,
domains : ( certs && certs . altnames ) || [ domain ] ,
certs : certs ,
certificate : { } ,
account : { }
} ;
opts . wildname =
2019-10-08 10:51:15 +00:00
'*.' +
( domain || '' )
. split ( '.' )
2019-06-03 09:12:11 +00:00
. slice ( 1 )
2019-10-08 10:51:15 +00:00
. join ( '.' ) ;
2019-06-03 09:12:11 +00:00
function cb2 ( results ) {
log (
gl . debug ,
2019-10-08 10:51:15 +00:00
'gl.approveDomains called with certs for' ,
( results . certs && results . certs . altnames ) || 'NONE' ,
'and options:'
2019-06-03 09:12:11 +00:00
) ;
log ( gl . debug , results . options || results ) ;
var err ;
if ( ! results ) {
2019-10-08 10:51:15 +00:00
err = new Error ( 'E_REJECT_SNI' ) ;
err . code = 'E_REJECT_SNI' ;
2019-06-03 09:12:11 +00:00
eb2 ( err ) ;
return ;
}
var options = results . options || results ;
if ( opts !== options ) {
Object . keys ( options ) . forEach ( function ( key ) {
2019-10-08 10:51:15 +00:00
if (
'undefined' !== typeof options [ key ] &&
'domain' !== key
) {
2019-06-03 09:12:11 +00:00
opts [ key ] = options [ key ] ;
}
} ) ;
options = opts ;
}
2019-10-08 10:51:15 +00:00
if (
Array . isArray ( options . altnames ) &&
options . altnames . length
) {
2019-06-03 09:12:11 +00:00
options . domains = options . altnames ;
}
options . altnames = options . domains ;
// just in case we get a completely different object from the one we originally created
if ( ! options . account ) {
options . account = { } ;
}
if ( ! options . certificate ) {
options . certificate = { } ;
}
if ( results . certs ) {
2019-10-08 10:51:15 +00:00
log ( gl . debug , 'gl renewing' ) ;
return gl . core . certificates
. renewAsync ( options , results . certs )
. then (
function ( certs ) {
// Workaround for https://github.com/nodejs/node/issues/22389
gl . _updateServernames ( certs ) ;
cb ( null , certs ) ;
} ,
function ( e ) {
console . debug (
"Error renewing certificate for '" +
domain +
"':"
) ;
console . debug ( e ) ;
console . error ( '' ) ;
cb ( e ) ;
}
) ;
2019-06-03 09:12:11 +00:00
} else {
2019-10-08 10:51:15 +00:00
log (
gl . debug ,
'gl getting from disk or registering new'
) ;
2019-06-03 09:12:11 +00:00
return gl . core . certificates . getAsync ( options ) . then (
function ( certs ) {
// Workaround for https://github.com/nodejs/node/issues/22389
gl . _updateServernames ( certs ) ;
cb ( null , certs ) ;
} ,
function ( e ) {
console . debug (
2019-10-08 10:51:15 +00:00
"Error loading/registering certificate for '" +
domain +
"':"
2019-06-03 09:12:11 +00:00
) ;
console . debug ( e ) ;
2019-10-08 10:51:15 +00:00
console . error ( '' ) ;
2019-06-03 09:12:11 +00:00
cb ( e ) ;
}
) ;
}
}
function eb2 ( _err ) {
if ( false !== gl . logRejectedDomains ) {
console . error (
2019-10-08 10:51:15 +00:00
"[Error] approveDomains rejected tls sni '" +
domain +
"'"
2019-06-03 09:12:11 +00:00
) ;
console . error (
2019-10-08 10:51:15 +00:00
'[Error] (see https://git.coolaj86.com/coolaj86/greenlock.js/issues/11)'
2019-06-03 09:12:11 +00:00
) ;
2019-10-08 10:51:15 +00:00
if ( 'E_REJECT_SNI' !== _err . code ) {
console . error (
'[Error] This is the rejection message:'
) ;
2019-06-03 09:12:11 +00:00
console . error ( _err . message ) ;
}
2019-10-08 10:51:15 +00:00
console . error ( '' ) ;
2019-06-03 09:12:11 +00:00
}
cb ( _err ) ;
return ;
}
function mb2 ( _err , results ) {
if ( _err ) {
eb2 ( _err ) ;
return ;
}
cb2 ( results ) ;
}
try {
if ( 1 === gl . approveDomains . length ) {
Promise . resolve ( gl . approveDomains ( opts ) )
. then ( cb2 )
. catch ( eb2 ) ;
} else if ( 2 === gl . approveDomains . length ) {
gl . approveDomains ( opts , mb2 ) ;
} else {
gl . approveDomains ( opts , certs , mb2 ) ;
}
} catch ( e ) {
2019-10-08 10:51:15 +00:00
console . error (
'[ERROR] Something went wrong in approveDomains:'
) ;
2019-06-03 09:12:11 +00:00
console . error ( e ) ;
console . error (
"BUT WAIT! Good news: It's probably your fault, so you can probably fix it."
) ;
}
} ;
}
2019-10-08 10:51:15 +00:00
gl . sni = gl . sni || require ( 'le-sni-auto' ) ;
2019-06-03 09:12:11 +00:00
if ( gl . sni . create ) {
gl . sni = gl . sni . create ( gl ) ;
}
gl . tlsOptions . SNICallback = function ( _domain , cb ) {
// format and (lightly) sanitize sni so that users can be naive
// and not have to worry about SQL injection or fs discovery
2019-10-08 10:51:15 +00:00
var domain = ( _domain || '' ) . toLowerCase ( ) ;
2019-06-03 09:12:11 +00:00
// hostname labels allow a-z, 0-9, -, and are separated by dots
// _ is sometimes allowed
// REGEX // https://www.codeproject.com/Questions/1063023/alphanumeric-validation-javascript-without-regex
if (
! gl . _ _sni _allow _dangerous _names &&
2019-10-08 10:51:15 +00:00
( ! /^[a-z0-9_\.\-]+$/i . test ( domain ) ||
- 1 !== domain . indexOf ( '..' ) )
2019-06-03 09:12:11 +00:00
) {
log ( gl . debug , "invalid sni '" + domain + "'" ) ;
2019-10-08 10:51:15 +00:00
cb ( new Error ( 'invalid SNI' ) ) ;
2019-06-03 09:12:11 +00:00
return ;
}
try {
2019-10-08 10:51:15 +00:00
gl . sni . sniCallback (
( gl . _ _sni _preserve _case && _domain ) || domain ,
cb
) ;
2019-06-03 09:12:11 +00:00
} catch ( e ) {
2019-10-08 10:51:15 +00:00
console . error (
'[ERROR] Something went wrong in the SNICallback:'
) ;
2019-06-03 09:12:11 +00:00
console . error ( e ) ;
cb ( e ) ;
}
} ;
}
// We want to move to using tlsOptions instead of httpsOptions, but we also need to make
// sure anything that uses this object will still work if looking for httpsOptions.
gl . httpsOptions = gl . tlsOptions ;
if ( gl . core . create ) {
gl . core = gl . core . create ( gl ) ;
}
gl . renew = function ( args , certs ) {
return gl . core . certificates . renewAsync ( args , certs ) ;
} ;
gl . register = function ( args ) {
return gl . core . certificates . getAsync ( args ) ;
} ;
gl . check = function ( args ) {
// TODO must return email, domains, tos, pems
return gl . core . certificates . checkAsync ( args ) ;
} ;
2019-10-08 10:51:15 +00:00
gl . middleware = gl . middleware || require ( './lib/middleware' ) ;
2019-06-03 09:12:11 +00:00
if ( gl . middleware . create ) {
gl . middleware = gl . middleware . create ( gl ) ;
}
//var SERVERNAME_RE = /^[a-z0-9\.\-_]+$/;
var SERVERNAME _G = /[^a-z0-9\.\-_]/ ;
gl . middleware . sanitizeHost = function ( app ) {
return function ( req , res , next ) {
function realNext ( ) {
2019-10-08 10:51:15 +00:00
if ( 'function' === typeof app ) {
2019-06-03 09:12:11 +00:00
app ( req , res ) ;
2019-10-08 10:51:15 +00:00
} else if ( 'function' === typeof next ) {
2019-06-03 09:12:11 +00:00
next ( ) ;
} else {
res . statusCode = 500 ;
2019-10-08 10:51:15 +00:00
res . end ( 'Error: no middleware assigned' ) ;
2019-06-03 09:12:11 +00:00
}
}
// Get the host:port combo, if it exists
2019-10-08 10:51:15 +00:00
var host = ( req . headers . host || '' ) . split ( ':' ) ;
2019-06-03 09:12:11 +00:00
// if not, move along
if ( ! host [ 0 ] ) {
realNext ( ) ;
return ;
}
// if so, remove non-allowed characters
2019-10-08 10:51:15 +00:00
var safehost = host [ 0 ] . toLowerCase ( ) . replace ( SERVERNAME _G , '' ) ;
2019-06-03 09:12:11 +00:00
// if there were unallowed characters, complain
if (
! gl . _ _sni _allow _dangerous _names &&
safehost . length !== host [ 0 ] . length
) {
res . statusCode = 400 ;
res . end ( "Malformed HTTP Header: 'Host: " + host [ 0 ] + "'" ) ;
return ;
}
// make lowercase
if ( ! gl . _ _sni _preserve _case ) {
host [ 0 ] = safehost ;
2019-10-08 10:51:15 +00:00
req . headers . host = host . join ( ':' ) ;
2019-06-03 09:12:11 +00:00
}
// Note: This sanitize function is also called on plain sockets, which don't need Domain Fronting checks
if ( req . socket . encrypted && ! gl . _ _sni _allow _domain _fronting ) {
2019-10-08 10:51:15 +00:00
if ( req . socket && 'string' === typeof req . socket . servername ) {
2019-06-03 09:12:11 +00:00
// Workaround for https://github.com/nodejs/node/issues/22389
if (
2019-10-08 10:51:15 +00:00
! gl . _checkServername (
safehost ,
req . socket . servername . toLowerCase ( )
)
2019-06-03 09:12:11 +00:00
) {
res . statusCode = 400 ;
2019-10-08 10:51:15 +00:00
res . setHeader (
'Content-Type' ,
'text/html; charset=utf-8'
) ;
2019-06-03 09:12:11 +00:00
res . end (
2019-10-08 10:51:15 +00:00
'<h1>Domain Fronting Error</h1>' +
2019-06-03 09:12:11 +00:00
"<p>This connection was secured using TLS/SSL for '" +
req . socket . servername . toLowerCase ( ) +
"'</p>" +
"<p>The HTTP request specified 'Host: " +
safehost +
"', which is (obviously) different.</p>" +
2019-10-08 10:51:15 +00:00
'<p>Because this looks like a domain fronting attack, the connection has been terminated.</p>'
2019-06-03 09:12:11 +00:00
) ;
return ;
}
} else if (
safehost &&
! gl . middleware . sanitizeHost . _skip _fronting _check
) {
// TODO how to handle wrapped sockets, as with telebit?
console . warn (
2019-10-08 10:51:15 +00:00
'\n\n\n[greenlock] WARN: no string for req.socket.servername,' +
2019-06-03 09:12:11 +00:00
" skipping fronting check for '" +
safehost +
"'\n\n\n"
) ;
gl . middleware . sanitizeHost . _skip _fronting _check = true ;
}
}
// carry on
realNext ( ) ;
} ;
} ;
gl . middleware . sanitizeHost . _skip _fronting _check = false ;
return gl ;
2015-12-11 14:22:46 +00:00
} ;