Please document the list of possible errors for tls#TLSSocket#authorizationError

[rogierschouten]

Is your feature request related to a problem? Please describe.
I'm trying to implement the EST enrollment protocol over TLS. In this protocol, I have to continue the TLS connection even on SOME of the possible TLS handshake errors. Unfortunately, the list of possible errors is not documented (the NodeJS Errors documentation page doesn't list them and neither does the TLS documentation page)

Describe the solution you'd like
The NodeJS TLS documentation page should list all possible values for the authorizationError property

[bnoordhuis]

Pull request welcome. You can find the list of codes here:

node/src/node_crypto.cc

Lines 2563 to 2589 in 0150490

	CASE_X509_ERR(UNABLE_TO_GET_ISSUER_CERT)
	CASE_X509_ERR(UNABLE_TO_GET_CRL)
	CASE_X509_ERR(UNABLE_TO_DECRYPT_CERT_SIGNATURE)
	CASE_X509_ERR(UNABLE_TO_DECRYPT_CRL_SIGNATURE)
	CASE_X509_ERR(UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY)
	CASE_X509_ERR(CERT_SIGNATURE_FAILURE)
	CASE_X509_ERR(CRL_SIGNATURE_FAILURE)
	CASE_X509_ERR(CERT_NOT_YET_VALID)
	CASE_X509_ERR(CERT_HAS_EXPIRED)
	CASE_X509_ERR(CRL_NOT_YET_VALID)
	CASE_X509_ERR(CRL_HAS_EXPIRED)
	CASE_X509_ERR(ERROR_IN_CERT_NOT_BEFORE_FIELD)
	CASE_X509_ERR(ERROR_IN_CERT_NOT_AFTER_FIELD)
	CASE_X509_ERR(ERROR_IN_CRL_LAST_UPDATE_FIELD)
	CASE_X509_ERR(ERROR_IN_CRL_NEXT_UPDATE_FIELD)
	CASE_X509_ERR(OUT_OF_MEM)
	CASE_X509_ERR(DEPTH_ZERO_SELF_SIGNED_CERT)
	CASE_X509_ERR(SELF_SIGNED_CERT_IN_CHAIN)
	CASE_X509_ERR(UNABLE_TO_GET_ISSUER_CERT_LOCALLY)
	CASE_X509_ERR(UNABLE_TO_VERIFY_LEAF_SIGNATURE)
	CASE_X509_ERR(CERT_CHAIN_TOO_LONG)
	CASE_X509_ERR(CERT_REVOKED)
	CASE_X509_ERR(INVALID_CA)
	CASE_X509_ERR(PATH_LENGTH_EXCEEDED)
	CASE_X509_ERR(INVALID_PURPOSE)
	CASE_X509_ERR(CERT_UNTRUSTED)
	CASE_X509_ERR(CERT_REJECTED)

Node uses the textual error message as the error code when it doesn't recognize openssl's status code. You can find that list here but note that it may change anytime openssl is upgraded:

node/deps/openssl/openssl/crypto/x509/x509_txt.c

Lines 21 to 182 in 0150490

	const char *X509_verify_cert_error_string(long n)
	{
	switch ((int)n) {
	case X509_V_OK:
	return "ok";
	case X509_V_ERR_UNSPECIFIED:
	return "unspecified certificate verification error";
	case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
	return "unable to get issuer certificate";
	case X509_V_ERR_UNABLE_TO_GET_CRL:
	return "unable to get certificate CRL";
	case X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE:
	return "unable to decrypt certificate's signature";
	case X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE:
	return "unable to decrypt CRL's signature";
	case X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY:
	return "unable to decode issuer public key";
	case X509_V_ERR_CERT_SIGNATURE_FAILURE:
	return "certificate signature failure";
	case X509_V_ERR_CRL_SIGNATURE_FAILURE:
	return "CRL signature failure";
	case X509_V_ERR_CERT_NOT_YET_VALID:
	return "certificate is not yet valid";
	case X509_V_ERR_CERT_HAS_EXPIRED:
	return "certificate has expired";
	case X509_V_ERR_CRL_NOT_YET_VALID:
	return "CRL is not yet valid";
	case X509_V_ERR_CRL_HAS_EXPIRED:
	return "CRL has expired";
	case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
	return "format error in certificate's notBefore field";
	case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
	return "format error in certificate's notAfter field";
	case X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD:
	return "format error in CRL's lastUpdate field";
	case X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD:
	return "format error in CRL's nextUpdate field";
	case X509_V_ERR_OUT_OF_MEM:
	return "out of memory";
	case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT:
	return "self signed certificate";
	case X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN:
	return "self signed certificate in certificate chain";
	case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY:
	return "unable to get local issuer certificate";
	case X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE:
	return "unable to verify the first certificate";
	case X509_V_ERR_CERT_CHAIN_TOO_LONG:
	return "certificate chain too long";
	case X509_V_ERR_CERT_REVOKED:
	return "certificate revoked";
	case X509_V_ERR_INVALID_CA:
	return "invalid CA certificate";
	case X509_V_ERR_PATH_LENGTH_EXCEEDED:
	return "path length constraint exceeded";
	case X509_V_ERR_INVALID_PURPOSE:
	return "unsupported certificate purpose";
	case X509_V_ERR_CERT_UNTRUSTED:
	return "certificate not trusted";
	case X509_V_ERR_CERT_REJECTED:
	return "certificate rejected";
	case X509_V_ERR_SUBJECT_ISSUER_MISMATCH:
	return "subject issuer mismatch";
	case X509_V_ERR_AKID_SKID_MISMATCH:
	return "authority and subject key identifier mismatch";
	case X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH:
	return "authority and issuer serial number mismatch";
	case X509_V_ERR_KEYUSAGE_NO_CERTSIGN:
	return "key usage does not include certificate signing";
	case X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER:
	return "unable to get CRL issuer certificate";
	case X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION:
	return "unhandled critical extension";
	case X509_V_ERR_KEYUSAGE_NO_CRL_SIGN:
	return "key usage does not include CRL signing";
	case X509_V_ERR_UNHANDLED_CRITICAL_CRL_EXTENSION:
	return "unhandled critical CRL extension";
	case X509_V_ERR_INVALID_NON_CA:
	return "invalid non-CA certificate (has CA markings)";
	case X509_V_ERR_PROXY_PATH_LENGTH_EXCEEDED:
	return "proxy path length constraint exceeded";
	case X509_V_ERR_KEYUSAGE_NO_DIGITAL_SIGNATURE:
	return "key usage does not include digital signature";
	case X509_V_ERR_PROXY_CERTIFICATES_NOT_ALLOWED:
	return
	"proxy certificates not allowed, please set the appropriate flag";
	case X509_V_ERR_INVALID_EXTENSION:
	return "invalid or inconsistent certificate extension";
	case X509_V_ERR_INVALID_POLICY_EXTENSION:
	return "invalid or inconsistent certificate policy extension";
	case X509_V_ERR_NO_EXPLICIT_POLICY:
	return "no explicit policy";
	case X509_V_ERR_DIFFERENT_CRL_SCOPE:
	return "Different CRL scope";
	case X509_V_ERR_UNSUPPORTED_EXTENSION_FEATURE:
	return "Unsupported extension feature";
	case X509_V_ERR_UNNESTED_RESOURCE:
	return "RFC 3779 resource not subset of parent's resources";
	case X509_V_ERR_PERMITTED_VIOLATION:
	return "permitted subtree violation";
	case X509_V_ERR_EXCLUDED_VIOLATION:
	return "excluded subtree violation";
	case X509_V_ERR_SUBTREE_MINMAX:
	return "name constraints minimum and maximum not supported";
	case X509_V_ERR_APPLICATION_VERIFICATION:
	return "application verification failure";
	case X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPE:
	return "unsupported name constraint type";
	case X509_V_ERR_UNSUPPORTED_CONSTRAINT_SYNTAX:
	return "unsupported or invalid name constraint syntax";
	case X509_V_ERR_UNSUPPORTED_NAME_SYNTAX:
	return "unsupported or invalid name syntax";
	case X509_V_ERR_CRL_PATH_VALIDATION_ERROR:
	return "CRL path validation error";
	case X509_V_ERR_PATH_LOOP:
	return "Path Loop";
	case X509_V_ERR_SUITE_B_INVALID_VERSION:
	return "Suite B: certificate version invalid";
	case X509_V_ERR_SUITE_B_INVALID_ALGORITHM:
	return "Suite B: invalid public key algorithm";
	case X509_V_ERR_SUITE_B_INVALID_CURVE:
	return "Suite B: invalid ECC curve";
	case X509_V_ERR_SUITE_B_INVALID_SIGNATURE_ALGORITHM:
	return "Suite B: invalid signature algorithm";
	case X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED:
	return "Suite B: curve not allowed for this LOS";
	case X509_V_ERR_SUITE_B_CANNOT_SIGN_P_384_WITH_P_256:
	return "Suite B: cannot sign P-384 with P-256";
	case X509_V_ERR_HOSTNAME_MISMATCH:
	return "Hostname mismatch";
	case X509_V_ERR_EMAIL_MISMATCH:
	return "Email address mismatch";
	case X509_V_ERR_IP_ADDRESS_MISMATCH:
	return "IP address mismatch";
	case X509_V_ERR_DANE_NO_MATCH:
	return "No matching DANE TLSA records";
	case X509_V_ERR_EE_KEY_TOO_SMALL:
	return "EE certificate key too weak";
	case X509_V_ERR_CA_KEY_TOO_SMALL:
	return "CA certificate key too weak";
	case X509_V_ERR_CA_MD_TOO_WEAK:
	return "CA signature digest algorithm too weak";
	case X509_V_ERR_INVALID_CALL:
	return "Invalid certificate verification context";
	case X509_V_ERR_STORE_LOOKUP:
	return "Issuer certificate lookup error";
	case X509_V_ERR_NO_VALID_SCTS:
	return "Certificate Transparency required, but no valid SCTs found";
	case X509_V_ERR_PROXY_SUBJECT_NAME_VIOLATION:
	return "proxy subject name violation";
	case X509_V_ERR_OCSP_VERIFY_NEEDED:
	return "OCSP verification needed";
	case X509_V_ERR_OCSP_VERIFY_FAILED:
	return "OCSP verification failed";
	case X509_V_ERR_OCSP_CERT_UNKNOWN:
	return "OCSP unknown cert";
	default:
	/* Printing an error number into a static buffer is not thread-safe */
	return "unknown certificate verification error";
	}
	}

[rogierschouten]

Hi @bnoordhuis, thank you for the list.

As for the PR, maybe this makes you understand why I won't (and if not, so be it): when I myself write code and/or I do a PR, you can expect that there are tests, and documentation of any new public interfaces. I see that as part of being a conscientious/professional programmer. I don't feel like doing someone's interface documentation for them

[bnoordhuis]

If you're trying to shame someone into stepping up: that code was written a long time ago by people who haven't been involved with the project for years.

If you're not interested enough to open a PR, then I'll go ahead and close this out. You're the first one to inquire so it can't be that sorely missed from the docs.