Introduction

Couchbase Lite is a lightweight, embedded, NoSQL JSON document database designed for mobile devices and edge computing platforms. One of its primary uses is enabling offline-first applications with automatic data synchronization to a central Couchbase Server or other devices. However, managing HTTPS URLs and ensuring seamless and secure synchronization is essential for maintaining data integrity and security. In this article, we'll delve into how to allow all HTTPS URLs to sync with Couchbase Lite for Android.

Prerequisites

Before diving into HTTPS configurations, ensure that you have:

• Basic knowledge of Android development.
• A Couchbase Lite setup in your Android application.
• HTTPS configuration on your server (with valid SSL/TLS certificates).

Enabling HTTPS Synchronization in Couchbase Lite

Couchbase Lite uses replication to synchronize data between the local database and a remote database or another peer. To allow all HTTPS URLs to sync, follow these steps:

Step 1: Setup Sync Gateway

Ensure that your Couchbase Sync Gateway is configured with a valid HTTPS connection. This typically involves:

1. Obtaining an SSL certificate (e.g., from Let’s Encrypt).
2. Configuring your web server (e.g., Nginx, Apache) to handle HTTPS requests and forward them to the Sync Gateway.

Configuring the Sync Gateway with HTTPS is outside this article's scope, but documentation is available on the Couchbase website.

Step 2: Enabling HTTPS in Android

To use HTTPS with Couchbase Lite in Android, configure Couchbase Lite to trust all certificates if you want to allow self-signed certificates for development purposes. Note: This is insecure and should only be used for testing. For production, always validate certificates properly.

Here's a Java code snippet to help configure the replication:

1ReplicationConfig config = new ReplicationConfig(database, target);
2config.setReplicatorType(ReplicatorType.PUSH_AND_PULL);
3
4TLSIdentity pinningRevokedIdentities = cn.getTcpTlsIdentities().get(0);
5
6config.setPinnedServerCertificate(pinningRevokedIdentities.getUnflaggedCert().unwrap());
7
8Replicator replicator = new Replicator(config);
9replicator.start();

Step 3: Setup Certificate Pinning

For production usage, implement certificate pinning. Certificate pinning enhances security by ensuring the app connects only to hosts with a valid, known certificate.

1// Load Your Certificate
2InputStream certInputStream = context.getResources().openRawResource(R.raw.my_cert);
3CertificateFactory certificateFactory = CertificateFactory.getInstance("X.509");
4X509Certificate myCert = (X509Certificate) certificateFactory.generateCertificate(certInputStream);
5
6// Pin the certificate
7TLSIdentity pinningIdentity = CertUtils.createPrivateKeyIdentityIfPossible(database.getContext(), false);
8config.setPinnedServerCertificate(pinningIdentity.getUnflaggedCert().unwrap());

Step 4: Implement Secure Replication

Implement secure replication using Couchbase Lite’s API:

1DatabaseConfiguration databaseConfig = new DatabaseConfiguration(context);
2Database database = new Database("my-database", databaseConfig);
3
4URLEndpoint endpoint = new URLEndpoint(new URI("https://your-server:4984/mydatabase"));
5ReplicatorConfiguration replicatorConfig = new ReplicatorConfiguration(database, endpoint);
6
7replicatorConfig.setAuthenticator(new BasicAuthenticator("username", "password".toCharArray()));
8replicatorConfig.setReplicatorType(ReplicatorType.PUSH_AND_PULL);
9replicatorConfig.setContinuous(true);
10
11Replicator replicator = new Replicator(replicatorConfig);
12replicator.start();

Common HTTPS Synchronization Issues

• Certificate Authority Issues: Ensure that the certificate authority used is trusted by the Android operating system.
• Certificate Expiry: Regularly update certificates before they expire to avoid connectivity issues.
• Network Configuration: Ensure the device's network settings are correct and the sync gateway is reachable.

Summary Table

Conclusion

Setting up HTTPS synchronization in Couchbase Lite for Android involves ensuring your Sync Gateway is correctly configured, understanding the difference between development and production environments, and correctly implementing certificate management. Always prioritize security by using certificate pinning and ensuring valid, up-to-date certificates are used in the application. By following these steps and practices, you can maintain secure, reliable data synchronization between your mobile and backend infrastructure.