NetworkSecurityConfig

Kotlin |Java

public final class NetworkSecurityConfig
extends Object

java.lang.Object
↳	android.security.net.config.NetworkSecurityConfig

The security configuration to use when performing network communications.

A NetworkSecurityConfig can specify security requirements for all network communications, or for communications with a specific domain or localhost connections.

See also:

Summary

Nested classes
`class`	`NetworkSecurityConfig.Builder` Builder for creating `NetworkSecurityConfig` objects.

Public methods
`static NetworkSecurityConfig`	`createBaseConfig(Context context)` Returns a base `NetworkSecurityConfig` using the provided app's defaults.
`static NetworkSecurityConfig`	`createLocalhostConfig()` Returns a `NetworkSecurityConfig` for localhost.
`int`	`getDomainEncryptionMode()`
`boolean`	`isCertificateTransparencyVerificationRequired()`
`boolean`	`isCleartextTrafficPermitted()`

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

createBaseConfig

Added in API level 10000

public static NetworkSecurityConfig createBaseConfig (Context context)

Returns a base NetworkSecurityConfig using the provided app's defaults.

An app default configuration has the following properties:

If the application targets API level 27 (Android O MR1) or lower, cleartext traffic is allowed by default.
Cleartext traffic is not permitted for ephemeral apps.
No certificate pinning is used.
The system certificate store is trusted for connections.
If the application targets API level 23 (Android M) or lower than the user certificate store is trusted by default as well for non-privileged applications.
Privileged applications do not trust the user certificate store on Android P and higher.

Parameters
`context`	`Context`: of the application. Must not be `null`.

Returns
`NetworkSecurityConfig`	the application `NetworkSecurityConfig`, or `null` if the config cannot be found.

createLocalhostConfig

Added in API level 10000

public static NetworkSecurityConfig createLocalhostConfig ()

Returns a NetworkSecurityConfig for localhost.

The localhost configuration has the following properties:

Cleartext traffic is permitted.
Certificate Transparency is disabled.

Returns
`NetworkSecurityConfig`	the `NetworkSecurityConfig`. This value cannot be `null`.

getDomainEncryptionMode

Added in API level 10000

public int getDomainEncryptionMode ()

Returns
`int`	the domain encryption mode. For possible values see `NetworkSecurityPolicy.getDomainEncryptionMode(String)`. Value is one of the following: `NetworkSecurityPolicy.DOMAIN_ENCRYPTION_MODE_UNKNOWN` `NetworkSecurityPolicy.DOMAIN_ENCRYPTION_MODE_DISABLED` `NetworkSecurityPolicy.DOMAIN_ENCRYPTION_MODE_OPPORTUNISTIC` `NetworkSecurityPolicy.DOMAIN_ENCRYPTION_MODE_ENABLED`

isCertificateTransparencyVerificationRequired

Added in API level 10000

public boolean isCertificateTransparencyVerificationRequired ()

Returns
`boolean`	true if Certificate Transparency is required for this `NetworkSecurityConfig`.

isCleartextTrafficPermitted

Added in API level 10000

public boolean isCleartextTrafficPermitted ()

Returns
`boolean`	true if cleartext traffic is permitted for this `NetworkSecurityConfig`.

NetworkSecurityConfig

Summary

Nested classes

Public methods

Inherited methods

Public methods

createBaseConfig

createLocalhostConfig

getDomainEncryptionMode

isCertificateTransparencyVerificationRequired

isCleartextTrafficPermitted