Fireshield (Hydra transport)

Categorization service (aka Fireshield) (Hydra transport only)

The Unified SDK offers domain categorization functionality, enabling you to classify domains and perform specific actions on them while the traffic passes through a VPN connection. To set up this feature, see below:

final SessionInfo session = new SessionConfig.Builder()
                .withLocation(UnifiedSDK.COUNTRY_OPTIMAL)
                .withReason(TrackingConstants.GprReasons.M_UI)
                .withFireshieldConfig(new FireshieldConfig.Builder()
                        .enabled(true)
                        .addService(FireshieldConfig.Services.IP)
                        .addService(FireshieldConfig.Services.BITDEFENDER)
                        .addCategory(FireshieldCategory.Builder.vpn(FireshieldConfig.Categories.SAFE))
                        .addCategory(FireshieldCategory.Builder.block(FireshieldConfig.Categories.MALWARE))
                        .addCategoryRule(FireshieldCategoryRule.Builder.fromAssets(FireshieldConfig.Categories.MALWARE,"malware-domains.txt")))
                .build();
UnifiedSdk sdk = UnifiedSdk.getInstance();
sdk.getVpn().start(session, new CompletableCallback() {
    @Override
    public void complete() {

    }

    @Override
    public void error(@NonNull VpnException e) {

    }
});

Fireshield Config

Categorization configuration based on specification of categories and rules for categories.

To create categories, you can use one of factory methods:

• FireshieldCategory.Builder.vpn - create a category with VPN action (traffic (encrypted) goes through the tunnel as IP packets )

• FireshieldCategory.Builder.proxy - create a category with Proxy action (traffic (encrypted) goes through the tunnel as a payload (for TCP only))

• FireshieldCategory.Builder.bypass - create a category with Bypass action (traffic goes directly to its destination, without a vpn tunnel)

• FireshieldCategory.Builder.block - create a category with Block action (traffic gets blocked)

• FireshieldCategory.Builder.blockAlertPage - create a category with Block action (traffic gets blocked) and a redirection to a specified Alert Page (works for HTTP only)

To create category rules (which domains get to specified category) you can use one of the factory methods:

• FireshieldCategoryRule.Builder.fromAssets - create category rules from file stored in Assets folder

• FireshieldCategoryRule.Builder.fromDomains - create category rules from the list of domains

• FireshieldCategoryRule.Builder.fromFile - create category rules from file on SD card/internal storage

To add to a category file configuration it's possible to use online categorization services.

Possible values are defined as constants in FireshieldConfig.Services.

Alert page configuration

AlertPage static method accepts two parameters: domain and path, on categorization action user will be redirected to [https://domain/page?url=<blocked_url>]

FireshieldConfig.Builder builder = new FireshieldConfig.Builder();
...
        .alertPage(AlertPage.create("connect.bitdefender.net", "safe_zone"))
...

Receive information about categorized domains

SDK will fire callback when transport detect access to configure rule.

UnifiedSDK.addVpnCallListener(new VpnCallback() {
    @Override
    public void onVpnCall(@NonNull Parcelable parcelable) {
        if (parcelable instanceof HydraResource){
            // handle categorization information
        }
    }
});

Categorization stats

SDK provides access to some categorization stats

final FireshieldStats stats = new FireshieldStatus();
//get total scanned connections count
stats.getScannedConnectionsCount(new Callback<Integer>() {
    @Override
    public void success(@NonNull Integer integer) {

    }

    @Override
    public void failure(@NonNull VpnException e) {

    }
});
//get current session scanned connections count
stats.getSessionScannedConnectionsCount();

//reset total scanned connections count
stats.resetScannedConnectionsCount();

Fireshield dynamic whitelist

Categorised domains could be added to whitelist to change category for current session without restart. This setting will reset on session stop.

final HydraResource resource = //current blocked domain
new FireshieldStatus().addFireshieldWhitelist(
    new String[]{ resource.getResource() },
    HydraResource.ResourceRequestOp.ADD, 
    resource.getResourceType(), 
    "safe",
    CompletableCallback.EMPTY
);

Fireshield remote configuration

In addition to local configuration, fireshield can be globally configured on developer dashboard under Settings->Fireshield

Default local/remote resolution rules:

• remote enabled overrides local enabled

• remote alert page overrides local alert page

• remote services if specified override local services

• remote category overrides locally specified behaviour, if not specified will be added to config

• remote category rules appends to local defined category rules