Skip to content

Commit

Permalink
[README] Move Changelog to the end of the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Flowdalic committed Feb 17, 2022
1 parent 8a6f0d5 commit 6559d9e
Showing 1 changed file with 27 additions and 23 deletions.
50 changes: 27 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,6 @@ If you don't add the new PIN, your clients wont be able to connect to your serve
Please inform yourself about the available alternatives to Java Pinning to determine if your use case is a match for Java Pinning.
See also the "Alternatives" section in this README.

Changelog
---------

### 1.1.0

- Added support for the Java 7 `X509ExtendedTrustManager` if your project uses Java 7 please use `Java7Pinning` instead of `JavaPinning`.
- Two new factory methods `JavaPinning.trustManagerForPins(String...)` and `JavaPinning.forPins(String...)`.
- Deprecated `JavaPinning.trustManagerforpins()` in favor of the correctly named `JavaPinning.trustManagerForpins()`.
- Two new factory methods `CertPlainPin.fromCertificate` and `PlainPin.fromPublicKey` these methods can be used to directly create pins from X509 certificates or X509 public keys.
- Two new getter methods `CertPlainPin.getX509Certificate()` and `PlainPin.getPublicKey()`.
- Two new factory methods in `JavaPinning`
- The `PinningTrustManager` now throws a specialized exception when a certificate is not pinned `CertificateNotPinnedException` which is a sub-type of `CertificateException`, this allows you to differentiate pinning exceptions from other certificate related exceptions.
- New class `HexUtilities` which contains methods to decode from HEX to bytes and encode bytes to HEX
- The `JavaPinningUtil` class has been deprecated in favor of `HexUtilities`, beaware of the fact that the methods in `HexUtilities` behave slightly better, but different).

### 1.0.1

The Pin format requirements have been relaxed. The Pin string may now contain

- Colons (':')
- Uppercase characters
- Spaces

How to use
----------

Expand Down Expand Up @@ -175,3 +152,30 @@ Run tests with
```bash
gradle check
```

Changelog
---------

### 1.2.0

- Fix dependency declarations

### 1.1.0

- Added support for the Java 7 `X509ExtendedTrustManager` if your project uses Java 7 please use `Java7Pinning` instead of `JavaPinning`.
- Two new factory methods `JavaPinning.trustManagerForPins(String...)` and `JavaPinning.forPins(String...)`.
- Deprecated `JavaPinning.trustManagerforpins()` in favor of the correctly named `JavaPinning.trustManagerForpins()`.
- Two new factory methods `CertPlainPin.fromCertificate` and `PlainPin.fromPublicKey` these methods can be used to directly create pins from X509 certificates or X509 public keys.
- Two new getter methods `CertPlainPin.getX509Certificate()` and `PlainPin.getPublicKey()`.
- Two new factory methods in `JavaPinning`
- The `PinningTrustManager` now throws a specialized exception when a certificate is not pinned `CertificateNotPinnedException` which is a sub-type of `CertificateException`, this allows you to differentiate pinning exceptions from other certificate related exceptions.
- New class `HexUtilities` which contains methods to decode from HEX to bytes and encode bytes to HEX
- The `JavaPinningUtil` class has been deprecated in favor of `HexUtilities`, beaware of the fact that the methods in `HexUtilities` behave slightly better, but different).

### 1.0.1

The Pin format requirements have been relaxed. The Pin string may now contain

- Colons (':')
- Uppercase characters
- Spaces

0 comments on commit 6559d9e

Please sign in to comment.