Plugin that uses a client certificate for authentication, with special myp12 file association as described below.
This plugin uses iOS implementation and API based on: mwaylabs/cordova-plugin-client-certificate
This plugin version is known to include code from the following other plugin versions:
EbilPanda/cordova-plugin-client-certificate-ebilpandaaddictic/cordova-plugin-client-certificate-addicticzxyang/cordova-plugin-clientcertificate(this version seems to have copied some version of the code fromjohannes-staehlin/cordova-client-cert-authentication)mwaylabs/cordova-plugin-client-certificatejohannes-staehlin/cordova-client-cert-authentication
LICENSE: Apache 2.0, with some code for iOS under Apple MIT License (more detailed license statement below)
This plugin handles client certificate request on iOS and Android. On iOS this plugin version supports using client certificates from both file association and local file system, as documented below. On Android this plugin supports using client certificates from the key chain, using shared preferences from the preference manager (code from johannes-staehlin/cordova-client-cert-authentication).
Specific for Android:
- Android platform implementation was replaced with an implementation that is almost the same as
johannes-staehlin/cordova-client-cert-authentication, which does not work with any JavaScript API at all (see documentation below).
This combined plugin version for iOS and Android was sponsored by Neptune Software, a low-code enterprise software platform company.
Recommended:
Install Cordova File API plugin (cordova-plugin-file), as described below:
$ cordova plugin add cordova-plugin-file
Optional:
Add the following to config.xml:
<platform name="android">
<preference name="AndroidPersistentFileLocation" value="Internal" />
</platform>
<platform name="ios">
<preference name="iosPersistentFileLocation" value="Library" />
</platform>Create a new Cordova Project
$ cordova create hello com.example.helloapp Hello
Install the plugin, for example:
$ cd hello
$ cordova plugin add https://github.com/cordova-ccafix/cordova-plugin-client-certificate-support
Install File API plugin:
$ cordova plugin add cordova-plugin-file
This plugin adds certificate-based authentication (SSO) to your cordova application. There is no extra coding or Android platform knowledge required when using this plugin on Android. It does not contain any JavaScript part since it just waits until the SSLSocket asks the client for a certificate and then shows the default client-cert pop-up you would also get when visiting your web page using the Android Chrome browser.
(Not supported by the JavaScript API)
for iOS ONLY:
WARNING: Client certificate should NEVER be included in the www folder or any other part of a published app.
FOR TESTING PURPOSES ONLY (see warning above): Copy a client certificate into the www folder.
Edit www/js/index.js and add the following code inside onDeviceReady:
clientCertificate.registerAuthenticationCertificate("certfilePath/cert.p12", "s3cr37", success, failure);- FOR TESTING PURPOSES ONLY (see warning above): Copy of an embedded certificate in
www(read only) to a directory accessible in read/write - Retrieve the final path and execute the handshake SSL
Add the following code inside onDeviceReady:
var certAutomate = 'mycert.p12';
var certFolder = 'certificates/';
var appDir = cordova.file.applicationDirectory + 'www/';
var datDir = cordova.file.dataDirectory;
window.resolveLocalFileSystemURL(datDir, function(DirectoryEntry){
// Create certFolder if doesn't exists in a r/w location (dataDirectory)
DirectoryEntry.getDirectory(certFolder, {create: true, exclusive: false}, copyCertificateAutomate, onFailure);
}, onFailure);
var copyCertificateAutomate = function(DirectoryEntry){
window.resolveLocalFileSystemURL(appDir + certFolder + certAutomate, function(FileEntry){
window.resolveLocalFileSystemURL(datDir + certFolder + certAutomate, certAuthenticate, function(){
// Copy the file to the r/w folder if not exists
FileEntry.copyTo(DirectoryEntry, certAutomate, onSuccess, onFailure);
});
}, certAuthenticate);
};
var certAuthenticate = function() {
// Full path to the cert
var p12path = datDir.substring(7) + certFolder + certAutomate;
var p12pass = 'myPassword';
// Updated API from mwaylabs/cordova-plugin-client-certificate
clientCertificate.registerAuthenticationCertificate(p12path, p12pass, certificateRegistred, onFailure);
};
var certificateRegistred = function(message) {
console.log(message);
// launch your web service that requires certificate authentication here
};
var onSuccess = function(message){
console.log('Success : ', message);
};
var onFailure = function(message){
console.log('Error : ', message);
};Install iOS and Android platform
cordova platform add ios
cordova platform add android
Run the code
cordova run android
cordova run ios
- Prompt the user for a p12 certificate password on iOS, if necessary. Native dialog prompt would be ideal; using JavaScript on this plugin or callback to the application code would also be possible.
- Add Windows platform
For more information on setting up Cordova see the Cordova CLI documentation
For more info on plugins see the Cordova Plugin Development Guide
Feel free to contribute code to this project through GitHub by forking the repository and sending a pull request.
Copyright 2019 Christopher J. Brody
Copyright 2018 Johannes Stählin
with code from other authors and contributors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
with some code for iOS under Apple MIT License