about summary refs log tree commit diff stats
path: root/org.fox.ttrss
diff options
context:
space:
mode:
authorAndrew Dolgov <fox@fakecake.org>2025-10-11 14:35:52 +0300
committerAndrew Dolgov <fox@fakecake.org>2025-10-11 14:35:52 +0300
commite68e92712f7f2ccc2340446c83a08b9361dc7d6a (patch)
treee46ea789fdcbb8d328c170691ead5fad9021cecf /org.fox.ttrss
parentf185badcc83e66eb200ac78c9829e2bd961f028f (diff)
downloadtt-rss-android-e68e92712f7f2ccc2340446c83a08b9361dc7d6a.tar.gz
tt-rss-android-e68e92712f7f2ccc2340446c83a08b9361dc7d6a.tar.xz
implement mTLS support with system keychain
Diffstat (limited to 'org.fox.ttrss')
-rw-r--r--org.fox.ttrss/src/main/java/org/fox/ttrss/ApiCommon.java57
-rwxr-xr-xorg.fox.ttrss/src/main/java/org/fox/ttrss/CommonActivity.java3
-rwxr-xr-xorg.fox.ttrss/src/main/java/org/fox/ttrss/NetworkPreferencesFragment.java42
-rw-r--r--org.fox.ttrss/src/main/java/org/fox/ttrss/glide/OkHttpProgressGlideModule.java51
-rw-r--r--org.fox.ttrss/src/main/java/org/fox/ttrss/util/KeyChainKeyManager.java58
-rwxr-xr-xorg.fox.ttrss/src/main/res/values/strings.xml3
-rwxr-xr-xorg.fox.ttrss/src/main/res/xml/preferences_network.xml11
7 files changed, 215 insertions, 10 deletions
diff --git a/org.fox.ttrss/src/main/java/org/fox/ttrss/ApiCommon.java b/org.fox.ttrss/src/main/java/org/fox/ttrss/ApiCommon.java
index 688656e9..70de409a 100644
--- a/org.fox.ttrss/src/main/java/org/fox/ttrss/ApiCommon.java
+++ b/org.fox.ttrss/src/main/java/org/fox/ttrss/ApiCommon.java
@@ -5,8 +5,11 @@ import android.content.Context;
 import android.content.SharedPreferences;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
+import android.content.res.AssetFileDescriptor;
 import android.net.ConnectivityManager;
 import android.net.NetworkInfo;
+import android.security.KeyChain;
+import android.security.KeyChainException;
 import android.util.Log;
 
 import androidx.annotation.NonNull;
@@ -17,11 +20,24 @@ import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
 
+import org.fox.ttrss.util.KeyChainKeyManager;
+
+import java.io.FileInputStream;
 import java.io.IOException;
+import java.io.InputStream;
+import java.security.KeyStore;
+import java.security.PrivateKey;
+import java.security.cert.X509Certificate;
 import java.util.HashMap;
 import java.util.Locale;
 import java.util.concurrent.TimeUnit;
 
+import javax.net.ssl.KeyManager;
+import javax.net.ssl.KeyManagerFactory;
+import javax.net.ssl.SSLContext;
+import javax.net.ssl.TrustManager;
+import javax.net.ssl.TrustManagerFactory;
+
 import okhttp3.Credentials;
 import okhttp3.HttpUrl;
 import okhttp3.Interceptor;
@@ -166,12 +182,41 @@ public class ApiCommon {
 
             /* lets shamelessly hijack OkHttpProgressGlideModule */
 
-            OkHttpClient client = new OkHttpClient.Builder()
-                    .connectTimeout(10, TimeUnit.SECONDS)
-                    .writeTimeout(10, TimeUnit.SECONDS)
-                    .readTimeout(30, TimeUnit.SECONDS)
-                    .addNetworkInterceptor(createInterceptor(listener))
-                    .build();
+            OkHttpClient.Builder builder = new OkHttpClient.Builder()
+                .connectTimeout(10, TimeUnit.SECONDS)
+                .writeTimeout(10, TimeUnit.SECONDS)
+                .readTimeout(30, TimeUnit.SECONDS)
+                .addNetworkInterceptor(createInterceptor(listener));
+
+            String clientCertAlias = m_prefs.getString("mtls_certificate_alias", null);
+
+            if (m_prefs.getBoolean("mtls_enabled", false) && clientCertAlias != null) {
+                try {
+                    X509Certificate[] chain = KeyChain.getCertificateChain(context, clientCertAlias);
+                    PrivateKey privateKey = KeyChain.getPrivateKey(context, clientCertAlias);
+
+                    KeyManager[] keyManagers = new KeyManager[]{new KeyChainKeyManager(clientCertAlias, chain, privateKey)};
+
+                    TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
+
+                    // we don't need custom CA
+                    trustManagerFactory.init((KeyStore) null);
+                    TrustManager[] trustManagers = trustManagerFactory.getTrustManagers();
+
+                    SSLContext sslContext = SSLContext.getInstance("TLS");
+                    sslContext.init(keyManagers, trustManagers, null);
+
+                    // enable mtls in okhttp3 builder
+                    builder.sslSocketFactory(sslContext.getSocketFactory());
+                } catch (Exception e) {
+                    e.printStackTrace();
+
+                    caller.setLastErrorMessage(e.getMessage());
+                    caller.setLastError(ApiError.API_UNKNOWN);
+                }
+            }
+
+            OkHttpClient client = builder.build();
 
             Response response = client.newCall(request).execute();
 
diff --git a/org.fox.ttrss/src/main/java/org/fox/ttrss/CommonActivity.java b/org.fox.ttrss/src/main/java/org/fox/ttrss/CommonActivity.java
index 69eed3bf..efee81b4 100755
--- a/org.fox.ttrss/src/main/java/org/fox/ttrss/CommonActivity.java
+++ b/org.fox.ttrss/src/main/java/org/fox/ttrss/CommonActivity.java
@@ -321,7 +321,8 @@ public class CommonActivity extends AppCompatActivity implements SharedPreferenc
 
         String[] filter = new String[]{"enable_dynamic_colors", "enable_cats", "widget_update_interval",
                 "headlines_swipe_to_dismiss", "headlines_mark_read_scroll", "headlines_request_size",
-                "force_phone_layout", "open_on_startup", "window_secure_mode", "enable_icon_tinting"};
+                "force_phone_layout", "open_on_startup", "window_secure_mode", "enable_icon_tinting",
+                "mtls_enabled"};
 
         m_needRestart = Arrays.asList(filter).contains(key);
     }
diff --git a/org.fox.ttrss/src/main/java/org/fox/ttrss/NetworkPreferencesFragment.java b/org.fox.ttrss/src/main/java/org/fox/ttrss/NetworkPreferencesFragment.java
index b279f307..44343dcd 100755
--- a/org.fox.ttrss/src/main/java/org/fox/ttrss/NetworkPreferencesFragment.java
+++ b/org.fox.ttrss/src/main/java/org/fox/ttrss/NetworkPreferencesFragment.java
@@ -1,14 +1,56 @@
 package org.fox.ttrss;
 
+import android.content.SharedPreferences;
 import android.os.Bundle;
+import android.os.Handler;
+import android.os.Looper;
+import android.security.KeyChain;
+import android.security.KeyChainAliasCallback;
+import android.util.Log;
 
 import androidx.annotation.Nullable;
 import androidx.preference.PreferenceFragmentCompat;
+import androidx.preference.PreferenceManager;
 
 public class NetworkPreferencesFragment extends PreferenceFragmentCompat {
 
     @Override
     public void onCreatePreferences(@Nullable Bundle savedInstanceState, @Nullable String rootKey) {
         setPreferencesFromResource(R.xml.preferences_network, rootKey);
+
+        SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(getActivity().getApplicationContext());
+
+        findPreference("mtls_pick_certificate").setSummary(prefs.getString("mtls_certificate_alias", ""));
+
+        findPreference("mtls_pick_certificate").setOnPreferenceClickListener(preference -> {
+            KeyChain.choosePrivateKeyAlias(
+                    getActivity(), // The current Activity
+                    new KeyChainAliasCallback() {
+                        @Override
+                        public void alias(String alias) {
+                            if (alias != null) {
+                                Log.d("NetworkPreferencesFragment", "picked key alias: " + alias);
+
+                                getActivity().runOnUiThread(() -> {
+                                    preference.setSummary(alias);
+
+                                    SharedPreferences.Editor editor = prefs.edit();
+                                    editor.putString("mtls_certificate_alias", alias);
+                                    editor.apply();
+
+                                });
+                            }
+                        }
+                    },
+                    new String[]{"RSA", "DSA"}, // Acceptable key types
+                    null, // Acceptable issuers (null for any)
+                    null, // Host (null for any)
+                    -1, // Port (-1 for any)
+                    null // Default alias (optional)
+            );
+
+            return false;
+        });
+
     }
 }
\ No newline at end of file
diff --git a/org.fox.ttrss/src/main/java/org/fox/ttrss/glide/OkHttpProgressGlideModule.java b/org.fox.ttrss/src/main/java/org/fox/ttrss/glide/OkHttpProgressGlideModule.java
index 842f1f07..b50a4bee 100644
--- a/org.fox.ttrss/src/main/java/org/fox/ttrss/glide/OkHttpProgressGlideModule.java
+++ b/org.fox.ttrss/src/main/java/org/fox/ttrss/glide/OkHttpProgressGlideModule.java
@@ -1,11 +1,15 @@
 package org.fox.ttrss.glide;
 
 import android.content.Context;
+import android.content.SharedPreferences;
 import android.graphics.BitmapFactory;
 import android.os.Handler;
 import android.os.Looper;
+import android.security.KeyChain;
 import android.util.Size;
 
+import androidx.preference.PreferenceManager;
+
 import com.bumptech.glide.Glide;
 import com.bumptech.glide.Registry;
 import com.bumptech.glide.annotation.GlideModule;
@@ -13,12 +17,23 @@ import com.bumptech.glide.integration.okhttp3.OkHttpUrlLoader;
 import com.bumptech.glide.load.model.GlideUrl;
 import com.bumptech.glide.module.AppGlideModule;
 
+import org.fox.ttrss.ApiCommon;
+import org.fox.ttrss.util.KeyChainKeyManager;
+
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.security.KeyStore;
+import java.security.PrivateKey;
+import java.security.cert.X509Certificate;
 import java.util.HashMap;
 import java.util.Map;
 
+import javax.net.ssl.KeyManager;
+import javax.net.ssl.SSLContext;
+import javax.net.ssl.TrustManager;
+import javax.net.ssl.TrustManagerFactory;
+
 import okhttp3.HttpUrl;
 import okhttp3.Interceptor;
 import okhttp3.MediaType;
@@ -36,9 +51,39 @@ import okio.Source;
 public class OkHttpProgressGlideModule extends AppGlideModule {
     @Override
     public void registerComponents(Context context, Glide glide, Registry registry) {
-        OkHttpClient client = new OkHttpClient.Builder()
-                .addNetworkInterceptor(createInterceptor(new DispatchingProgressListener()))
-                .build();
+
+        SharedPreferences m_prefs = PreferenceManager
+                .getDefaultSharedPreferences(context);
+
+        OkHttpClient.Builder builder = new OkHttpClient.Builder()
+                .addNetworkInterceptor(createInterceptor(new DispatchingProgressListener()));
+
+        String clientCertAlias = m_prefs.getString("mtls_certificate_alias", null);
+
+        if (m_prefs.getBoolean("mtls_enabled", false) && clientCertAlias != null) {
+            try {
+                X509Certificate[] chain = KeyChain.getCertificateChain(context, clientCertAlias);
+                PrivateKey privateKey = KeyChain.getPrivateKey(context, clientCertAlias);
+
+                KeyManager[] keyManagers = new KeyManager[]{new KeyChainKeyManager(clientCertAlias, chain, privateKey)};
+
+                TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
+
+                // we don't need custom CA
+                trustManagerFactory.init((KeyStore) null);
+                TrustManager[] trustManagers = trustManagerFactory.getTrustManagers();
+
+                SSLContext sslContext = SSLContext.getInstance("TLS");
+                sslContext.init(keyManagers, trustManagers, null);
+
+                // enable mtls in okhttp3 builder
+                builder.sslSocketFactory(sslContext.getSocketFactory());
+            } catch (Exception e) {
+                e.printStackTrace();
+            }
+        }
+
+        OkHttpClient client = builder.build();
 
         // registry.append() doesn't work...
         registry.prepend(GlideUrl.class, InputStream.class, new OkHttpUrlLoader.Factory(client));
diff --git a/org.fox.ttrss/src/main/java/org/fox/ttrss/util/KeyChainKeyManager.java b/org.fox.ttrss/src/main/java/org/fox/ttrss/util/KeyChainKeyManager.java
new file mode 100644
index 00000000..8b97aff3
--- /dev/null
+++ b/org.fox.ttrss/src/main/java/org/fox/ttrss/util/KeyChainKeyManager.java
@@ -0,0 +1,58 @@
+package org.fox.ttrss.util;
+
+import android.content.Context;
+import android.security.KeyChain;
+import android.security.KeyChainException;
+
+import java.net.Socket;
+import java.security.Principal;
+import java.security.PrivateKey;
+
+import javax.net.ssl.X509ExtendedKeyManager;
+import javax.security.cert.CertificateException;
+import java.security.cert.X509Certificate;
+
+public class KeyChainKeyManager extends X509ExtendedKeyManager {
+    private final String mClientAlias;
+    private final X509Certificate[] mCertificateChain;
+    private final PrivateKey mPrivateKey;
+
+    public KeyChainKeyManager(String clientAlias, X509Certificate[] certificateChain, PrivateKey privateKey) {
+        mClientAlias = clientAlias;
+        mCertificateChain = certificateChain;
+        mPrivateKey = privateKey;
+    }
+
+    @Override
+    public String chooseClientAlias(String[] keyTypes, Principal[] issuers, Socket socket) {
+        return mClientAlias;
+    }
+
+    @Override
+    public X509Certificate[] getCertificateChain(String alias) {
+        return mCertificateChain;
+    }
+
+    @Override
+    public PrivateKey getPrivateKey(String alias) {
+        return mPrivateKey;
+    }
+
+    @Override
+    public final String chooseServerAlias( String keyType, Principal[] issuers, Socket socket) {
+        // not a client SSLSocket callback
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public final String[] getClientAliases(String keyType, Principal[] issuers) {
+        // not a client SSLSocket callback
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public final String[] getServerAliases(String keyType, Principal[] issuers) {
+        // not a client SSLSocket callback
+        throw new UnsupportedOperationException();
+    }
+}
\ No newline at end of file
diff --git a/org.fox.ttrss/src/main/res/values/strings.xml b/org.fox.ttrss/src/main/res/values/strings.xml
index 304283fd..f6e76a77 100755
--- a/org.fox.ttrss/src/main/res/values/strings.xml
+++ b/org.fox.ttrss/src/main/res/values/strings.xml
@@ -317,4 +317,7 @@
     <string name="expand_special_cat">Expand Special category</string>
     <string name="article_enable_javascript">Enable JavaScript</string>
     <string name="article_enable_javascript_summary">Some iframe-based video players require JavaScript, enable with caution</string>
+    <string name="prefs_mutual_tls">Mutual TLS</string>
+    <string name="prefs_mtls_enabled">Enable mTLS</string>
+    <string name="prefs_mtls_pick_certificate">Choose client certificate</string>
 </resources>
diff --git a/org.fox.ttrss/src/main/res/xml/preferences_network.xml b/org.fox.ttrss/src/main/res/xml/preferences_network.xml
index d44284e6..76fc52ed 100755
--- a/org.fox.ttrss/src/main/res/xml/preferences_network.xml
+++ b/org.fox.ttrss/src/main/res/xml/preferences_network.xml
@@ -1,5 +1,16 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android" >
+    <PreferenceCategory android:title="@string/prefs_mutual_tls">
+        <SwitchPreferenceCompat
+            android:defaultValue="false"
+            android:key="mtls_enabled"
+            android:title="@string/prefs_mtls_enabled" />
+        <Preference
+            android:key="mtls_pick_certificate"
+            android:dependency="mtls_enabled"
+            android:title="@string/prefs_mtls_pick_certificate" />
+    </PreferenceCategory>
+
     <PreferenceCategory android:title="@string/http_authentication" >
         <EditTextPreference
             android:key="http_login"