Out-of-the-box working example for custom CA.

I have contributed a sample link on my personal server. It's dedicated solely for use by the library, and hopefully will not be abused.

Author: Noor Dawod

sample/src/main/java/com/loopj/android/http/sample/CustomCASample.java

@@ -20,14 +20,17 @@
 
 import android.app.AlertDialog;
 import android.content.DialogInterface;
+import android.content.res.Resources;
 import android.os.Bundle;
 import android.util.Log;
-import android.widget.Toast;
+import com.fasterxml.jackson.core.JsonFactory;
+import com.fasterxml.jackson.databind.ObjectMapper;
 
 import com.loopj.android.http.AsyncHttpClient;
-import com.loopj.android.http.BinaryHttpResponseHandler;
+import com.loopj.android.http.BaseJsonHttpResponseHandler;
 import com.loopj.android.http.RequestHandle;
 import com.loopj.android.http.ResponseHandlerInterface;
+import com.loopj.android.http.sample.util.SampleJSON;
 import com.loopj.android.http.sample.util.SecureSocketFactory;
 
 import org.apache.http.Header;
@@ -53,9 +56,16 @@ public class CustomCASample extends SampleParentActivity {
 
     private static final String LOG_TAG = "CustomCASample";
 
-    private static final String SERVER_TEST_URL = "https://httpbin.org/get";
-    private static final String STORE_ALIAS = "TheAlias";
-    private static final String STORE_PASS = "ThePass";
+    // This is A TEST URL for use with AsyncHttpClient LIBRARY ONLY!
+    // It is provided courtesy of Fineswap (http://fineswap.com) and must never
+    // be used in ANY program except when running this sample (CustomCASample).
+    private static final String SERVER_TEST_URL = "https://api.fineswap.io/ahc";
+
+    // The certificate's alias.
+    private static final String STORE_ALIAS = "rootca";
+
+    // The certificate's password.
+    private static final String STORE_PASS = "Fineswap";
 
     // Instruct the library to retry connection when this exception is raised.
     static {
@@ -89,59 +99,18 @@ protected void onCreate(Bundle savedInstanceState) {
             }
         } catch (KeyStoreException e) {
             Log.e(LOG_TAG, "Unable to initialize key store", e);
-            Toast.makeText(
-                    this,
-                    "Please read res/raw/custom_ca.txt\nto learn how to create your own\nkey store containing a custom CA",
-                    Toast.LENGTH_LONG).show();
             showCustomCAHelp();
         }
     }
 
-    /**
-     * Returns contents of `custom_ca.txt` as CharSequence
-     *
-     * @return contents of custom_ca.txt from Assets
-     */
-    private CharSequence getReadmeText() {
-        String rtn = "";
-        try {
-            InputStream stream = getResources().openRawResource(R.raw.custom_ca);
-            java.util.Scanner s = new java.util.Scanner(stream)
-                    .useDelimiter("\\A");
-            rtn = s.hasNext() ? s.next() : "";
-        } catch (Exception | Error e) {
-            Log.e(LOG_TAG, "License couldn't be retrieved", e);
-        }
-        return rtn;
-    }
-
-    /**
-     * Will display AlertDialog reading `custom_ca.txt` from Assets, to avoid strict Lint issue
-     */
-    private void showCustomCAHelp() {
-        AlertDialog.Builder builder = new AlertDialog.Builder(this);
-        builder.setTitle(R.string.title_custom_ca);
-        builder.setMessage(getReadmeText());
-        builder.setNeutralButton(android.R.string.cancel,
-                new DialogInterface.OnClickListener() {
-
-                    @Override
-                    public void onClick(DialogInterface dialog, int which) {
-                        dialog.dismiss();
-                    }
-                }
-        );
-        builder.show();
-    }
-
     @Override
     public int getSampleTitle() {
         return R.string.title_custom_ca;
     }
 
     @Override
     public boolean isRequestBodyAllowed() {
-        return true;
+        return false;
     }
 
     @Override
@@ -156,38 +125,78 @@ public String getDefaultURL() {
 
     @Override
     public ResponseHandlerInterface getResponseHandler() {
-        return new BinaryHttpResponseHandler() {
+        return new BaseJsonHttpResponseHandler<SampleJSON>() {
+
             @Override
             public void onStart() {
                 clearOutputs();
             }
 
             @Override
-            public String[] getAllowedContentTypes() {
-                // Allowing all data for debug purposes
-                return new String[]{".*"};
-            }
-
-            public void onSuccess(int statusCode, Header[] headers, byte[] binaryData) {
-                debugStatusCode(LOG_TAG, statusCode);
+            public void onSuccess(int statusCode, Header[] headers, String rawJsonResponse, SampleJSON response) {
                 debugHeaders(LOG_TAG, headers);
-                debugResponse(LOG_TAG, "Received response is " + binaryData.length + " bytes");
+                debugStatusCode(LOG_TAG, statusCode);
+                if (response != null) {
+                    debugResponse(LOG_TAG, rawJsonResponse);
+                }
             }
 
             @Override
-            public void onFailure(int statusCode, Header[] headers, byte[] errorResponse, Throwable e) {
+            public void onFailure(int statusCode, Header[] headers, Throwable throwable, String rawJsonData, SampleJSON errorResponse) {
                 debugHeaders(LOG_TAG, headers);
                 debugStatusCode(LOG_TAG, statusCode);
-                debugThrowable(LOG_TAG, e);
+                debugThrowable(LOG_TAG, throwable);
                 if (errorResponse != null) {
-                    debugResponse(LOG_TAG, "Received response is " + errorResponse.length + " bytes");
+                    debugResponse(LOG_TAG, rawJsonData);
                 }
             }
+
+            @Override
+            protected SampleJSON parseResponse(String rawJsonData, boolean isFailure) throws Throwable {
+                return new ObjectMapper().readValues(new JsonFactory().createParser(rawJsonData), SampleJSON.class).next();
+            }
         };
     }
 
     @Override
     public RequestHandle executeSample(AsyncHttpClient client, String URL, Header[] headers, HttpEntity entity, ResponseHandlerInterface responseHandler) {
         return client.get(this, URL, headers, null, responseHandler);
     }
+
+    /**
+     * Returns contents of `custom_ca.txt` file from assets as CharSequence.
+     *
+     * @return contents of custom_ca.txt file
+     */
+    private CharSequence getReadmeText() {
+        String rtn = "";
+        try {
+            InputStream stream = getResources().openRawResource(R.raw.custom_ca);
+            java.util.Scanner s = new java.util.Scanner(stream)
+                    .useDelimiter("\\A");
+            rtn = s.hasNext() ? s.next() : "";
+        } catch (Resources.NotFoundException e) {
+            Log.e(LOG_TAG, "License couldn't be retrieved", e);
+        }
+        return rtn;
+    }
+
+    /**
+     * Displays a dialog showing contents of `custom_ca.txt` file from assets.
+     * This is needed to avoid Lint's strict mode.
+     */
+    private void showCustomCAHelp() {
+        AlertDialog.Builder builder = new AlertDialog.Builder(this);
+        builder.setTitle(R.string.title_custom_ca);
+        builder.setMessage(getReadmeText());
+        builder.setNeutralButton(android.R.string.cancel,
+            new DialogInterface.OnClickListener() {
+                @Override
+                public void onClick(DialogInterface dialog, int which) {
+                    dialog.dismiss();
+                }
+            }
+        );
+        builder.show();
+    }
 }

sample/src/main/java/com/loopj/android/http/sample/FilesSample.java

@@ -33,7 +33,7 @@ public boolean isRequestBodyAllowed() {
     public RequestHandle executeSample(AsyncHttpClient client, String URL, Header[] headers, HttpEntity entity, ResponseHandlerInterface responseHandler) {
         try {
             RequestParams params = new RequestParams();
-            final String contentType = "application/octet-stream";
+            final String contentType = RequestParams.APPLICATION_OCTET_STREAM;
             params.put("fileOne", createTempFile("fileOne", 1020), contentType);
             params.put("fileTwo", createTempFile("fileTwo", 1030), contentType);
             params.put("fileThree", createTempFile("fileThree", 1040), contentType);

sample/src/main/res/raw/custom_ca.txt

@@ -1,6 +1,8 @@
 This is a short HOW-TO documenting the steps necessary to create a key store
 file that Android could use to connect to servers with a custom CA.
 
+This file's location is: 'res/raw/custom_ca.txt'
+
 Prerequisities:
 ---------------
 
@@ -23,6 +25,9 @@ Let's see the fun part:
 
    openssl req -newkey rsa:4096 -days 3650 -x509 -nodes -out ca.pem
 
+   This instructs openssl to create a 4096-bit RSA key and set its expiration
+   date 10 years later.
+
    You will be asked to provide details of the CA. When you're finished, a file
    called 'ca.pem' will exist in current directory.