capacitor-ssl-pinning - npm Package Compare versions

Comparing version 0.0.8 to 0.0.9

dist/docs.json

@@ -39,3 +39,3 @@ {
         {
-          "text": "{\n  /**\n   * The subject of the certificate\n   * @platform Android\n   */\n  subject?: string;\n  /**\n   * The issuer of the certificate\n   * @platform Android\n   */\n  issuer?: string;\n  /**\n   * The valid from date of the certificate\n   * @platform Android\n   */\n  validFrom?: string;\n  /**\n   * The valid to date of the certificate\n   * @platform Android\n   */\n  validTo?: string;\n  /**\n   * The expected fingerprint of the certificate\n   */\n  expectedFingerprint?: string;\n  /**\n   * The fingerprint of the certificate\n   */\n  actualFingerprint?: string;\n  /**\n   * Whether the fingerprint matches the expected fingerprint\n   */\n  fingerprintMatched?: boolean;\n  /**\n   * The error that occurred while checking the certificate\n   */\n  error?: string;\n}",
+          "text": "{\n  /**\n   * The subject of the certificate\n   * @platform Android\n   */\n  subject?: string;\n  /**\n   * The issuer of the certificate.\n   * Results vary between iOS and Android.\n   */\n  issuer?: string;\n  /**\n   * The valid from date of the certificate\n   * @platform Android\n   */\n  validFrom?: string;\n  /**\n   * The valid to date of the certificate\n   * @platform Android\n   */\n  validTo?: string;\n  /**\n   * The expected fingerprint of the certificate\n   */\n  expectedFingerprint?: string;\n  /**\n   * The fingerprint of the certificate\n   */\n  actualFingerprint?: string;\n  /**\n   * Whether the fingerprint matches the expected fingerprint\n   */\n  fingerprintMatched?: boolean;\n  /**\n   * The error that occurred while checking the certificate\n   */\n  error?: string;\n}",
           "complexTypes": []
@@ -42,0 +42,0 @@ }

dist/esm/types.d.ts

@@ -12,4 +12,4 @@ export declare type SSLCertificateCheckerOptions = {
     /**
-     * The issuer of the certificate
-     * @platform Android
+     * The issuer of the certificate.
+     * Results vary between iOS and Android.
      */
@@ -16,0 +16,0 @@ issuer?: string;

package.json

 {
   "name": "capacitor-ssl-pinning",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "Check/pin SSL certificates",
@@ -5,0 +5,0 @@ "main": "dist/plugin.cjs.js",

README.md

@@ -7,3 +7,6 @@ # Capacitor SSL Pinning
 
-Note: There are different ways of expressing the fingerprint, some may use colons and others may not. This plugin normalizes the fingerprint to lowercase and removes colons for comparison. While it expects uppercase, it should not make a difference if you use colons or not. However it is recommended to use the format from the docs.
+Note: 
+- On Fingerprints: There are different ways of expressing the fingerprint, some may use colons and others may not. This plugin normalizes the fingerprint to lowercase and removes colons for comparison. While it expects uppercase, it should not make a difference if you use colons or not. However it is recommended to use the format from the docs.
+- On Subject: The subject is the hostname of the certificate. On Android, the plugin returns the hostname of the certificate. On iOS, the plugin returns URL it was given.
+- On Issuer: The issuer is the issuer of the certificate. There are different formats on iOS and Android, their results are not guaranteed to be the same.
 
@@ -10,0 +13,0 @@ [![HitCount](https://hits.dwyl.com/mchl18/capacitor-ssl-pinning.svg)](https://hits.dwyl.com/mchl18/capacitor-ssl-pinning)

No alert changes

Improved metrics

Total package byte prevSize

34415

6.27%

Number of lines in readme file

158

1.94%

No dependency changes