Class Properties

java.lang.Object
org.bouncycastle.util.Properties

public class Properties extends Object
Utility method for accessing properties values - properties can be set in java.security, thread local, and system properties. They are checked for in the same order with checking stopped as soon as a value is found.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Controls whether an ASN.1 UTCTime / GeneralizedTime carrying non-DER contents may be serialized through a DEROutputStream.
    static final String
    Maximum depth of nested constructed ASN.1 objects the parser will descend before failing with "maximum nested construction level reached", guarding against stack exhaustion from deeply nested crafted input.
    static final String
    Overrides the maximum length accepted for a single definite-length ASN.1 object read from a stream whose length is not otherwise known.
    static final String
    Upper bound on the PBKDF2 iteration count honoured when deriving the integrity-MAC key of a BCFKS keystore during load.
    static final String
    Upper bound, in bytes, on the working memory (~128 * N * r) of the scrypt KDF honoured when deriving the integrity-MAC key of a BCFKS keystore during load.
    static final String
    The PBKDF2 iteration count the BCFKS keystore uses when writing a file through the plain KeyStore.store(OutputStream, char[]) path - the write-side counterpart of BCFKS_MAX_IT_COUNT, which only bounds what is accepted on load, and the BCFKS analogue of PKCS12_STORE_IT_COUNT.
    static final String
    Opt in to handling legacy version 0/1 BKS keystores.
    static final String
    Upper bound on the PKCS#12-PBE iteration count honoured when loading a BKS keystore.
    static final String
    Upper bound (in bits) on the prime modulus p accepted when validating an imported Diffie-Hellman public key.
    static final String
    Effective bits-of-entropy assumed per real bit when the BC DRBG provider seeds for a 256-bit security level — used to compute the byte-oriented samples requested from the underlying entropy source.
    static final String
    Fully-qualified name of an EntropySourceProvider class to use as the BC DRBG provider's seed source.
    static final String
    If set to "true", the BC DRBG provider runs a background thread that samples the platform entropy source on a fixed schedule and feeds the DRBG, rather than blocking on a fresh sample at each reseed.
    static final String
    Pause, in seconds, between background entropy-thread samples (see DRBG_ENTROPY_THREAD).
    static final String
    Upper bound (in bits) on the prime modulus p accepted when validating an imported DSA public key.
    static final String
    Upper bound on the field size m accepted when building a characteristic-2 (F2m) elliptic curve.
    static final String
    If set the provider will attempt, where possible, to behave the same way as the oracle one.
    static final String
    Opt in to short AEAD authentication tags for AES-GCM parameters.
    static final String
    Opt-in to the legacy "use the subject CN as a fallback identifier" behaviour in the BC JSSE provider's hostname verifier.
    static final String
    Maximum depth of nested multipart/* content the S/MIME canonicalisers will descend before failing, the MIME analogue of ASN1_MAX_CONS_DEPTH.
    static final String
    The largest OCSP response, in bytes, the CertPath validator - or the JSSE server's OCSP stapling fetch - will read from a responder.
    static final String
    The longest OpenPGP ASCII armor header line, in bytes, ArmoredInputStream will accumulate.
    static final String
    The largest number of OpenPGP ASCII armor header lines ArmoredInputStream will accept before the blank line that ends the header block.
    static final String
    Upper bound on the bcrypt round count honoured when decrypting an encrypted OpenSSH v1 private key.
    static final String
    Upper bound on the PBKDF2 iteration count honoured when BC takes that count from an untrusted encoding: decrypting a PBES2-protected PKCS#8 / PEM private key or PKCS#12 bag, verifying an RFC 9579 PBMAC1, unwrapping a CMS password recipient, and the raw JCA PBKDF2 provider (both the SecretKeyFactory derivation and the AlgorithmParameters parse a Cipher performs for PBES2).
    static final String
    Upper bound, in bytes, on the scrypt working memory (~128 * N * r) honoured when decrypting a PBES2-protected PKCS#8 / PEM private key.
    static final String
    If set to "true", RSA PKCS#1 v1.5 signature verification rejects DigestInfo encodings whose AlgorithmIdentifier omits the NULL parameters octets required by RFC 8017 sec.
    static final String
    If set to "true", the BC PKCS#12 KeyStore will additionally accept (on load only) SafeBags of type secretBag that use SunJCE's non-standard nested encoding — a SecretBag whose secretTypeId is pkcs8ShroudedKeyBag and whose secretValue is an EncryptedPrivateKeyInfo wrapping a PKCS#8 PrivateKeyInfo carrying the raw secret-key bytes.
    static final String
    A PKCS12 file which does not require a password will normally throw an exception if a password is provided.
    static final String
    If set, a PKCS12 file with a larger iteration count on PBE processing will rejected.
    static final String
    The PBE iteration count the PKCS12 keystore uses when writing a file - the write-side counterpart of PKCS12_MAX_IT_COUNT, which only bounds what is accepted on load.
    static final String
    Upper bound on the RFC 4211 PKMAC / CMP password-based-MAC iteration count honoured when no explicit ceiling was supplied to org.bouncycastle.cert.crmf.PKMACBuilder.
    static final String
    If set to "true", the certificate parser (TBSCertificate and everything built on it, such as the X.509 CertificateFactory) will accept a certificate whose issuer is an empty distinguished name.
    static final String
    Fall back to the legacy lenient parsing of rfc822Name values in X.509 name-constraint checks.
    static final String
    Maximum time, in seconds, that a downloaded CRL is cached by the internal CrlCache used by the CertPath validator and X509RevocationChecker.
    static final String
    Optional comma separated list of the protocols a CRL Distribution Point may name, applied by the internal CrlCache used by the CertPath validator and X509RevocationChecker before any connection is opened.
    static final String
    If set to "true", the BC CertPath validator and X509RevocationChecker will attempt to download CRLs over the network using URIs from each certificate's CRL Distribution Points extension when no PKIXCRLStore on the supplied PKIXParameters can satisfy the lookup.
    static final String
    Upper bound on the total number of nodes the PKIX certification-path builder visits while searching for a chain.
    static final String
    Upper bound on the total number of valid-policy-tree nodes retained (across all depth levels) during PKIX certification-path validation.
    static final String
    Opt in to the relaxed directoryName name-constraint matching required by GSMA SGP.22 v2.5 (Remote SIM Provisioning), sections 4.5.2.1.0.2 / 4.5.2.1.0.3.
  • Method Summary

    Modifier and Type
    Method
    Description
    static BigInteger
    asBigInteger(String propertyName)
    Return propertyName as a BigInteger.
    static int
    asInteger(String propertyName, int defaultValue)
    Return propertyName as an integer, defaultValue used if not defined.
    static Set<String>
    asKeySet(String propertyName)
     
    static String
    getPropertyValue(String propertyName)
    Return the String value of the property propertyName.
    static String
    getPropertyValue(String propertyName, String defValue)
     
    static boolean
    isOverrideSet(String propertyName)
    Return whether a particular override has been set to true.
    static boolean
    isOverrideSet(String propertyName, boolean defIsTrue)
    Return whether a particular override has been set to true.
    static boolean
    isOverrideSetTo(String propertyName, boolean isTrue)
    Return whether a particular override has been set to false.
    static boolean
    Remove any value for the specified override property for the current thread only.
    static boolean
    setThreadOverride(String propertyName, boolean enable)
    Enable the specified override property for the current thread only.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • EMULATE_ORACLE

      public static final String EMULATE_ORACLE
      If set the provider will attempt, where possible, to behave the same way as the oracle one.
      See Also:
    • PKCS12_IGNORE_USELESS_PASSWD

      public static final String PKCS12_IGNORE_USELESS_PASSWD
      A PKCS12 file which does not require a password will normally throw an exception if a password is provided. Setting PKCS12_IGNORE_USELESS_PASSWD to "true" will result in the provider ignoring a password if one is provided and not required.
      See Also:
    • PKCS12_MAX_IT_COUNT

      public static final String PKCS12_MAX_IT_COUNT
      If set, a PKCS12 file with a larger iteration count on PBE processing will rejected.
      See Also:
    • PKCS12_STORE_IT_COUNT

      public static final String PKCS12_STORE_IT_COUNT
      The PBE iteration count the PKCS12 keystore uses when writing a file - the write-side counterpart of PKCS12_MAX_IT_COUNT, which only bounds what is accepted on load. Default 600,000 for the key and certificate encryption, twice that for the integrity MAC.

      Lowering this trades password-cracking resistance for store/load time, and is only worth doing where something other than the passphrase carries the confidentiality of the file - a machine-generated high-entropy password, or a keystore held somewhere already protected. It is deliberately an operator decision rather than a per-call one: a deployment that wants cheaper files sets it once at startup for the whole JVM.

      A value outside 1 .. 2,500,000 is ignored and the default used, so a mistyped property fails towards the default rather than towards a file with no PBE work in it; the upper bound keeps the doubled MAC count inside the 5,000,000 that PKCS12_MAX_IT_COUNT defaults to, so a file written under this property can always be read back. Read via asInteger(String, int).

      See Also:
    • X509_CRL_CACHE_TTL

      public static final String X509_CRL_CACHE_TTL
      Maximum time, in seconds, that a downloaded CRL is cached by the internal CrlCache used by the CertPath validator and X509RevocationChecker. When set to a positive value, cached entries are evicted whichever expires sooner: the configured TTL or the CRL's own nextUpdate. Default (or 0) preserves the legacy behaviour of evicting only when nextUpdate has passed.
      See Also:
    • X509_ENABLE_CRLDP

      public static final String X509_ENABLE_CRLDP
      If set to "true", the BC CertPath validator and X509RevocationChecker will attempt to download CRLs over the network using URIs from each certificate's CRL Distribution Points extension when no PKIXCRLStore on the supplied PKIXParameters can satisfy the lookup. Default (unset / "false") preserves the legacy behaviour of relying entirely on caller-supplied CertStore / PKIXCRLStore registrations — "No CRLs found for issuer ..." is the result when the caller hasn't registered a store and this property is off.
      See Also:
    • X509_CRLDP_PROTOCOLS

      public static final String X509_CRLDP_PROTOCOLS
      Optional comma separated list of the protocols a CRL Distribution Point may name, applied by the internal CrlCache used by the CertPath validator and X509RevocationChecker before any connection is opened. Protocol names are matched without regard to case, so "http,https,ldap" refuses a distribution point naming ftp, file, jar or anything else the JVM happens to have a URL handler for. Default (unset or empty) leaves the protocol unrestricted: RFC 5280 sec. 4.2.1.13 requires a distribution point URI to name a protocol but does not limit which, and BC supports http, https, ftp and ldap here, so this is an operator policy for deployments that want a narrower set rather than a default.

      Note the CRL fetch this governs only happens at all when X509_ENABLE_CRLDP is set.

      See Also:
    • OCSP_MAX_RESPONSE_SIZE

      public static final String OCSP_MAX_RESPONSE_SIZE
      The largest OCSP response, in bytes, the CertPath validator - or the JSSE server's OCSP stapling fetch - will read from a responder. A responder's Content-Length can narrow this but never widen it, so a responder declaring (and sending) hundreds of megabytes is cut off rather than read into the heap. Default is 64K, which is far above any real response; a value of zero or less is ignored and the default used, so a mistyped value cannot turn the limit off. Exceeding the limit fails the OCSP check the same way an unreachable responder does, so a caller with CRLs configured falls back to those.
      See Also:
    • OPENPGP_MAX_ARMOR_HEADER_LENGTH

      public static final String OPENPGP_MAX_ARMOR_HEADER_LENGTH
      The longest OpenPGP ASCII armor header line, in bytes, ArmoredInputStream will accumulate. The headers are parsed when the stream is constructed, so this bounds what merely wrapping an untrusted stream can allocate: a "header line" that never reaches a line terminator is refused rather than read until the heap is gone. Default is 4096, far above the short Version / Comment lines RFC 9580 sec. 6.2 describes; a value of zero or less is ignored and the default used.
      See Also:
    • OPENPGP_MAX_ARMOR_HEADERS

      public static final String OPENPGP_MAX_ARMOR_HEADERS
      The largest number of OpenPGP ASCII armor header lines ArmoredInputStream will accept before the blank line that ends the header block. Bounds the companion case to OPENPGP_MAX_ARMOR_HEADER_LENGTH, where each line is short but they never stop arriving. Default is 64, counting the armor header line itself; a value of zero or less is ignored and the default used.
      See Also:
    • PKCS12_ALLOW_SUN_SECRET_KEYS

      public static final String PKCS12_ALLOW_SUN_SECRET_KEYS
      If set to "true", the BC PKCS#12 KeyStore will additionally accept (on load only) SafeBags of type secretBag that use SunJCE's non-standard nested encoding — a SecretBag whose secretTypeId is pkcs8ShroudedKeyBag and whose secretValue is an EncryptedPrivateKeyInfo wrapping a PKCS#8 PrivateKeyInfo carrying the raw secret-key bytes. Off by default; the BC keystore always writes the standards compliant RFC 7292 sec. 4.2.5 form regardless.
      See Also:
    • PKCS1_STRICT_DIGESTINFO

      public static final String PKCS1_STRICT_DIGESTINFO
      If set to "true", RSA PKCS#1 v1.5 signature verification rejects DigestInfo encodings whose AlgorithmIdentifier omits the NULL parameters octets required by RFC 8017 sec. 9.2 / Appendix A.2.4. By default (or "false") the verifier falls back to accepting that two-byte-shorter encoding for compatibility with implementations that have historically produced it; setting this property to "true" disables the fallback so only strictly RFC-compliant signatures verify (github #2273). Affects both the BC JCE provider's DigestSignatureSpi and the lightweight RSADigestSigner.
      See Also:
    • JSSE_HOSTNAME_CHECK_CN_FALLBACK

      public static final String JSSE_HOSTNAME_CHECK_CN_FALLBACK
      Opt-in to the legacy "use the subject CN as a fallback identifier" behaviour in the BC JSSE provider's hostname verifier. When the property is set to "true", a TLS server certificate that carries no SAN dNSName entries falls back to the most specific commonName attribute of the subject DN — this matches SunJSSE and historical OpenSSL behaviour.

      Default ("false" / unset) follows RFC 9525 sec. 6.3 (which deprecates CN-based identity for TLS) and CAB Forum Baseline Requirements 7.1.4.2 (which requires SAN dNSName entries for publicly-trusted TLS server certs). It also closes a Name-Constraint bypass surface (the 2026-03 cross-implementation X.509 audit): a constrained intermediate CA can omit dNSName SAN entries entirely so the path validator's Name-Constraint dNSName checks never fire, then embed an attacker-controlled hostname in CN — the JSSE verifier would have accepted the connection. Setting the property "false" (or leaving it unset) disables this fallback path and the JSSE verifier rejects any cert that doesn't carry a matching SAN identifier.

      See Also:
    • DRBG_EFFECTIVE_256BITS_ENTROPY

      public static final String DRBG_EFFECTIVE_256BITS_ENTROPY
      Effective bits-of-entropy assumed per real bit when the BC DRBG provider seeds for a 256-bit security level — used to compute the byte-oriented samples requested from the underlying entropy source. Defaults to 282 bits (about 0.9 effective bits per raw bit) and is rounded up to the next whole byte.
      See Also:
    • DRBG_ENTROPY_SOURCE

      public static final String DRBG_ENTROPY_SOURCE
      Fully-qualified name of an EntropySourceProvider class to use as the BC DRBG provider's seed source. When set, the named class is loaded reflectively and instantiated in place of the platform default. When unset, the BC DRBG falls back to the configured securerandom.source or its own background entropy thread.
      See Also:
    • DRBG_ENTROPY_THREAD

      public static final String DRBG_ENTROPY_THREAD
      If set to "true", the BC DRBG provider runs a background thread that samples the platform entropy source on a fixed schedule and feeds the DRBG, rather than blocking on a fresh sample at each reseed.
      See Also:
    • DRBG_GATHER_PAUSE_SECS

      public static final String DRBG_GATHER_PAUSE_SECS
      Pause, in seconds, between background entropy-thread samples (see DRBG_ENTROPY_THREAD). Parsed as an integer; absent or non-positive values use the implementation default.
      See Also:
    • ASN1_ALLOW_NON_DER_TIME

      public static final String ASN1_ALLOW_NON_DER_TIME
      Controls whether an ASN.1 UTCTime / GeneralizedTime carrying non-DER contents may be serialized through a DEROutputStream. Reading is always lenient: a wire value that is valid ASN.1 but not valid DER - for example a UTCTime without the seconds element ("YYMMDDHHMMZ"), a time terminated with a "+hhmm"/"-hhmm" offset rather than "Z", or a GeneralizedTime fraction carrying trailing zeros - parses without complaint into a usable ASN1UTCTime / ASN1GeneralizedTime.

      Default (unset or "true") preserves BC's historical pass-through: such a primitive may be re-emitted unchanged via either BER or DER. Setting this property to "false" enforces the DER restrictions of X.690 sec. 11.7 / 11.8 (and hence the RFC 5280 sec. 4.1.2.5 profile, which requires seconds and Zulu) on the DER write side: the primitive's toDERObject() throws an IllegalStateException if it would emit non-conformant content, so any attempt to write it to a DEROutputStream fails (github #1973 / #1986). BER serialization is unaffected. Programmatically constructing a time from a Date always produces DER content, so this setting only matters for primitives whose contents arrived non-conformant from the wire.

      See Also:
    • ASN1_MAX_CONS_DEPTH

      public static final String ASN1_MAX_CONS_DEPTH
      Maximum depth of nested constructed ASN.1 objects the parser will descend before failing with "maximum nested construction level reached", guarding against stack exhaustion from deeply nested crafted input. Read as an integer; default 64.
      See Also:
    • ASN1_MAX_LIMIT

      public static final String ASN1_MAX_LIMIT
      Overrides the maximum length accepted for a single definite-length ASN.1 object read from a stream whose length is not otherwise known. The value is a byte count and may carry a trailing 'k', 'm' or 'g' multiplier (e.g. "16m"); when unset the limit falls back to the available heap size. Can also be set per stream via the ASN1InputStream(InputStream, int) constructor.
      See Also:
    • DH_MAX_SIZE

      public static final String DH_MAX_SIZE
      Upper bound (in bits) on the prime modulus p accepted when validating an imported Diffie-Hellman public key. Validation performs a modular exponentiation / Legendre computation whose cost is super-linear in the size of p, so an unbounded p taken from a crafted key encoding would turn key import into a CPU-exhaustion denial of service. The default (16384) is the analogue of org.bouncycastle.rsa.max_size and is well above any standardised DH group. Read via asInteger(String, int).
      See Also:
    • DSA_MAX_SIZE

      public static final String DSA_MAX_SIZE
      Upper bound (in bits) on the prime modulus p accepted when validating an imported DSA public key. As with DH_MAX_SIZE, validation runs a modular exponentiation whose cost grows super-linearly in the size of p, so an unbounded p from a crafted encoding is an import-time CPU-exhaustion vector. Default 16384. Read via asInteger(String, int).
      See Also:
    • BCFKS_MAX_IT_COUNT

      public static final String BCFKS_MAX_IT_COUNT
      Upper bound on the PBKDF2 iteration count honoured when deriving the integrity-MAC key of a BCFKS keystore during load. The KDF runs on parameters taken from the (not-yet-verified) keystore, so an unbounded iteration count is a pre-integrity CPU-exhaustion vector. Default 5,000,000 (the BCFKS writer uses ~51,200). Read via asInteger(String, int).
      See Also:
    • BCFKS_MAX_SCRYPT_MEMORY

      public static final String BCFKS_MAX_SCRYPT_MEMORY
      Upper bound, in bytes, on the working memory (~128 * N * r) of the scrypt KDF honoured when deriving the integrity-MAC key of a BCFKS keystore during load. As with BCFKS_MAX_IT_COUNT the scrypt cost parameters are taken from the not-yet-verified keystore, so an unbounded cost is a pre-integrity memory-exhaustion vector. Default 1073741824 (1 GiB); the BCFKS writer uses N=16384, r=8 (~16 MiB). Read via asInteger(String, int).
      See Also:
    • BCFKS_STORE_IT_COUNT

      public static final String BCFKS_STORE_IT_COUNT
      The PBKDF2 iteration count the BCFKS keystore uses when writing a file through the plain KeyStore.store(OutputStream, char[]) path - the write-side counterpart of BCFKS_MAX_IT_COUNT, which only bounds what is accepted on load, and the BCFKS analogue of PKCS12_STORE_IT_COUNT. Default 51,200 (PBKDF2-HMAC-SHA512), applied to the integrity MAC key and to the key-encryption keys of the entries. A caller supplying a BCFKSLoadStoreParameter with its own PBKDFConfig is unaffected.

      Lowering this trades password-cracking resistance for store/load time, and is only worth doing where something other than the passphrase carries the confidentiality of the file. A value outside 1 .. 5,000,000 is ignored and the default used, so a mistyped property fails towards the default rather than towards a file with no PBE work in it; the upper bound is the BCFKS_MAX_IT_COUNT default, so a file written under this property can always be read back. Read via asInteger(String, int).

      See Also:
    • PBE_MAX_ITERATION_COUNT

      public static final String PBE_MAX_ITERATION_COUNT
      Upper bound on the PBKDF2 iteration count honoured when BC takes that count from an untrusted encoding: decrypting a PBES2-protected PKCS#8 / PEM private key or PKCS#12 bag, verifying an RFC 9579 PBMAC1, unwrapping a CMS password recipient, and the raw JCA PBKDF2 provider (both the SecretKeyFactory derivation and the AlgorithmParameters parse a Cipher performs for PBES2). In each case the key-derivation parameters travel inside an unauthenticated container, so an unbounded count makes processing attacker-supplied material a CPU-exhaustion vector. Default 10,000,000 - the count RFC 8018 sec. 4.2 names as possibly appropriate for especially critical keys, so generous enough for deliberately strong settings. Read via asInteger(String, int).
      See Also:
    • PBE_MAX_SCRYPT_MEMORY

      public static final String PBE_MAX_SCRYPT_MEMORY
      Upper bound, in bytes, on the scrypt working memory (~128 * N * r) honoured when decrypting a PBES2-protected PKCS#8 / PEM private key. As with PBE_MAX_ITERATION_COUNT the scrypt cost travels in the unauthenticated container, so an unbounded cost is a memory-exhaustion vector. Default 1073741824 (1 GiB). Read via asInteger(String, int).
      See Also:
    • PKMAC_MAX_ITERATION_COUNT

      public static final String PKMAC_MAX_ITERATION_COUNT
      Upper bound on the RFC 4211 PKMAC / CMP password-based-MAC iteration count honoured when no explicit ceiling was supplied to org.bouncycastle.cert.crmf.PKMACBuilder. The count travels in the (unauthenticated) PBMParameter of an incoming CMP message and drives an iterated hash, so an unbounded count makes verifying an attacker-supplied message a CPU-exhaustion vector. Default 10,000,000, generous enough for any legitimate setting. Read via asInteger(String, int).
      See Also:
    • X509_MAX_POLICY_NODES

      public static final String X509_MAX_POLICY_NODES
      Upper bound on the total number of valid-policy-tree nodes retained (across all depth levels) during PKIX certification-path validation. Certificate policy mapping combined with the anyPolicy expansion of RFC 5280 6.1.3/6.1.4 can grow the tree multiplicatively per certificate, so a crafted chain that still chains to a trust anchor could drive the validator into exponential memory/CPU consumption -- a denial of service of the class of CVE-2023-0464. The tree size is checked once per certificate and validation is aborted with a CertPathValidatorException once it exceeds this bound. The default (8192) is far above any legitimate policy tree (a real chain produces a handful of nodes) and is configurable for unusual deployments. Read via asInteger(String, int).
      See Also:
    • X509_MAX_CERT_PATH_BUILD_NODES

      public static final String X509_MAX_CERT_PATH_BUILD_NODES
      Upper bound on the total number of nodes the PKIX certification-path builder visits while searching for a chain. The builder does a depth-first walk up the PKI graph, bounded per path by cycle detection and the caller's maxPathLength. Because candidate issuers are matched by subject name only, a certificate store containing many certificates that share a subject name without chaining to a trust anchor can make the search explore a large number of partial paths before it concludes no chain exists. This bound keeps that work predictable: the visited-node count is checked on entry to each build step and the build is aborted with a CertPathBuilderException once it exceeds the bound. This is a hardening measure and the builder-side companion to X509_MAX_POLICY_NODES. The default (262144) is far above any legitimate build (a real build returns on the first path that chains to an anchor) and is configurable for unusual cross-certified meshes. Read via asInteger(String, int).
      See Also:
    • X509_SGP22_NAME_CONSTRAINTS

      public static final String X509_SGP22_NAME_CONSTRAINTS
      Opt in to the relaxed directoryName name-constraint matching required by GSMA SGP.22 v2.5 (Remote SIM Provisioning), sections 4.5.2.1.0.2 / 4.5.2.1.0.3. When set, a permitted-subtree RDN is satisfied by any matching subject RDN regardless of position, additional subject attributes beyond those named in the subtree are tolerated, and a serialNumber RDN is matched with a startsWith comparison wherever it appears. This is deliberately looser than the contiguous-prefix DN matching mandated by RFC 5280 7.1, so it defaults to off and must be enabled explicitly; BC's default validation remains RFC 5280 strict. See github #2327. Read via isOverrideSet(String).
      See Also:
    • X509_ALLOW_LENIENT_RFC822_NAME

      public static final String X509_ALLOW_LENIENT_RFC822_NAME
      Fall back to the legacy lenient parsing of rfc822Name values in X.509 name-constraint checks. By default the validator is strict about rfc822Name conformance; today that means a tested rfc822Name with more than one '@' is rejected as ambiguous when email constraints apply (RFC 5321 sec. 4.1.2 allows '@' inside a quoted local part, so the domain is not simply the text after the first '@', and a wrong split could evade a constraint). When this property is set, that strictness (and any future rfc822Name conformance strictness) is disabled and the historical permissive parsing is used instead. Strict is the default; set this only to restore the old behaviour. This is a safety valve, not a recommended mode. Read via isOverrideSet(String).
      See Also:
    • X509_ALLOW_EMPTY_ISSUER_CERT

      public static final String X509_ALLOW_EMPTY_ISSUER_CERT
      If set to "true", the certificate parser (TBSCertificate and everything built on it, such as the X.509 CertificateFactory) will accept a certificate whose issuer is an empty distinguished name. RFC 5280 sec. 4.1.2.4 requires the issuer field to contain a non-empty DN and the parser rejects an empty one by default, but some non-PKIX certificate profiles - notably the libp2p TLS profile, which uses a self-signed certificate purely as a peer-identity carrier - place no requirements on the issuer and such certificates are in circulation. This is a read-side concession only: certificate generation still requires a non-empty issuer unconditionally, and X509CertificateReviewer reports the empty issuer whether or not the property is set. Read via isOverrideSet(String).
      See Also:
    • GCM_ALLOW_SHORT_TAGS

      public static final String GCM_ALLOW_SHORT_TAGS
      Opt in to short AEAD authentication tags for AES-GCM parameters. RFC 5084 constrains the AES-GCM ICV (tag) length carried in GCMParameters to 12..16 octets (96..128 bits), and BC enforces that by default. When this property is set, GCMParameters additionally accepts tags down to the NIST SP 800-38D minimum of 4 octets (32 bits; SP 800-38D sec. 5.2.1.2 permits a 32-bit tag for limited applications). Short tags weaken integrity protection, so this defaults to off and must be enabled explicitly; anything below 4 octets or above 16 octets is still rejected. Read via isOverrideSet(String).
      See Also:
    • BKS_ENABLE_V1

      public static final String BKS_ENABLE_V1
      Opt in to handling legacy version 0/1 BKS keystores. Those stores derive the HMAC integrity key at only the digest size in bits (a 16-bit key for SHA-1; CVE-2018-5382), which is brute-forceable offline, so by default the default BKS keystore type refuses to load them and only writes the current version 2 format. Set this property to read or create the weak legacy format (e.g. to migrate an old store); it also gates registration of the separate BKS-V1 keystore type. Read via isOverrideSet(String).
      See Also:
    • BKS_MAX_IT_COUNT

      public static final String BKS_MAX_IT_COUNT
      Upper bound on the PKCS#12-PBE iteration count honoured when loading a BKS keystore. The count drives the integrity-MAC key derivation in BcKeyStoreSpi.engineLoad (and the per-entry sealed-key decryption), and is read from the (not-yet-verified) keystore ahead of the HMAC integrity check, so an unbounded value is a pre-integrity CPU-exhaustion vector - the analogue of BCFKS_MAX_IT_COUNT / PKCS12_MAX_IT_COUNT for the BKS format (the sibling UBER store already caps its own count). Default 1048576 (1 << 20); the BKS writer uses ~1024-2047. Read via asInteger(String, int).
      See Also:
    • OPENSSH_MAX_ROUNDS

      public static final String OPENSSH_MAX_ROUNDS
      Upper bound on the bcrypt round count honoured when decrypting an encrypted OpenSSH v1 private key. The count is read from the key's kdfoptions, which arrive unauthenticated, and drives the KDF before anything about the key has been verified, so an unbounded value is a pre-integrity CPU-exhaustion vector - the OpenSSH analogue of BCFKS_MAX_IT_COUNT / PKCS12_MAX_IT_COUNT. A round costs several milliseconds, so the 2^31-1 the wire format allows is worth CPU-months from a key file of a few hundred bytes. Reached only when a passphrase is supplied, i.e. on the key-import path. Default 1048576 (1 << 20); ssh-keygen defaults to 16 and its -a option is rarely taken far beyond a few hundred. Read via asInteger(String, int).
      See Also:
    • EC_MAX_F2M_FIELD_SIZE

      public static final String EC_MAX_F2M_FIELD_SIZE
      Upper bound on the field size m accepted when building a characteristic-2 (F2m) elliptic curve. The field polynomial is evaluated when the curve is constructed, and the cost grows with m, so an unbounded value taken from a certificate's or key's explicit EC parameters is an import-time CPU-exhaustion vector (CVE-2024-29857). Default 1142 (twice the 571 of the largest standardised binary curve, B-571/K-571); a larger m is rejected with an IllegalArgumentException. Read via asInteger(String, int).
      See Also:
    • MIME_MAX_DEPTH

      public static final String MIME_MAX_DEPTH
      Maximum depth of nested multipart/* content the S/MIME canonicalisers will descend before failing, the MIME analogue of ASN1_MAX_CONS_DEPTH. Each level of nesting in the signed half of an inbound multipart/signed costs a stack frame in SMIMEUtil.outputBodyPart plus the frames JavaMail spends resolving the part, so an unbounded depth turns a few hundred KB of crafted mail into a StackOverflowError. RFC 8551 sec. 3.1 requires an agent to receive nested S/MIME but does not require unbounded depth. Default 64; real mail nests two or three deep. Read via asInteger(String, int).
      See Also:
  • Method Details

    • isOverrideSet

      public static boolean isOverrideSet(String propertyName)
      Return whether a particular override has been set to true.
      Parameters:
      propertyName - the property name for the override.
      Returns:
      true if the property is set to "true", false otherwise.
    • isOverrideSet

      public static boolean isOverrideSet(String propertyName, boolean defIsTrue)
      Return whether a particular override has been set to true.
      Parameters:
      propertyName - the property name for the override.
      Returns:
      true if the property is set to "true", false otherwise.
    • isOverrideSetTo

      public static boolean isOverrideSetTo(String propertyName, boolean isTrue)
      Return whether a particular override has been set to false.
      Parameters:
      propertyName - the property name for the override.
      isTrue - true if the override should be true, false otherwise.
      Returns:
      true if the property is set to the value of isTrue, false otherwise.
    • setThreadOverride

      public static boolean setThreadOverride(String propertyName, boolean enable)
      Enable the specified override property for the current thread only.
      Parameters:
      propertyName - the property name for the override.
      enable - true if the override should be enabled, false if it should be disabled.
      Returns:
      true if the override was already set true, false otherwise.
    • removeThreadOverride

      public static boolean removeThreadOverride(String propertyName)
      Remove any value for the specified override property for the current thread only.
      Parameters:
      propertyName - the property name for the override.
      Returns:
      true if the override was already set true in thread local, false otherwise.
    • asInteger

      public static int asInteger(String propertyName, int defaultValue)
      Return propertyName as an integer, defaultValue used if not defined.
      Parameters:
      propertyName - name of property.
      defaultValue - integer to return if property not defined.
      Returns:
      value of property, or default if not found, as an int.
    • asBigInteger

      public static BigInteger asBigInteger(String propertyName)
      Return propertyName as a BigInteger.
      Parameters:
      propertyName - name of property.
      Returns:
      value of property as a BigInteger, null if not defined.
    • asKeySet

      public static Set<String> asKeySet(String propertyName)
    • getPropertyValue

      public static String getPropertyValue(String propertyName)
      Return the String value of the property propertyName. Property valuation starts with java.security, then thread local, then system properties.
      Parameters:
      propertyName - name of property.
      Returns:
      value of property as a String, null if not defined.
    • getPropertyValue

      public static String getPropertyValue(String propertyName, String defValue)