Release 0.1.0

CHANGELOG.md

@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [0.1.0] - 2022-12-12
 ### Added
 - APIs of the SAM image and SAM selection.
-- APIs related to signature computation and verification as well as counter and ceiling reading.
+- APIs related to signature computation and verification as well as counter and ceiling reading.
+
+[unreleased]: https://github.com/calypsonet/calypsonet-terminal-calypso-crypto-legacysam-java-api/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/calypsonet/calypsonet-terminal-calypso-crypto-legacysam-java-api/releases/tag/0.1.0

CONTRIBUTING.md

@@ -1,11 +1,11 @@
-# Contributing to 'Terminal Calypso API' Java implementation
+# Contributing to 'Terminal Calypso Crypto Legacy SAM API' Java implementation
 
 Thanks for your interest in this project.
 
 ## Contributing
 
-1. [Fork](https://help.github.com/articles/fork-a-repo) the [calypsonet/calypsonet-terminal-calypso-java-api](https://github.com/calypsonet/calypsonet-terminal-calypso-java-api) repository
-2. Clone repository: `git clone https://github.com/[your_github_username]/calypsonet-terminal-calypso-java-api.git`
+1. [Fork](https://help.github.com/articles/fork-a-repo) the [calypsonet/calypsonet-terminal-calypso-crypto-legacysam-java-api](https://github.com/calypsonet/calypsonet-terminal-calypso-crypto-legacysam-java-api) repository
+2. Clone repository: `git clone https://github.com/[your_github_username]/calypsonet-terminal-calypso-crypto-legacysam-java-api.git`
 3. Create your feature branch: `git checkout -b my-new-feature`
 4. Make your changes
 5. Commit your changes: `git commit -m "Add some feature" -s`

NOTICE.md

@@ -1,4 +1,4 @@
-# Notices for 'Terminal Calypso API' Java implementation
+# Notices for 'Terminal Calypso Crypto Legacy SAM API' Java implementation
 
 This content is produced and maintained by Calypso Networks Association.
 

PUBLISHERS.yml

@@ -1,4 +1,4 @@
-url: https://github.com/calypsonet/calypsonet-terminal-calypso-java-api
+url: https://github.com/calypsonet/calypsonet-terminal-calypso-crypto-legacysam-java-api
 organization:
   name: Calypso Networks Association
   url: https://calypsonet.org/
@@ -10,9 +10,9 @@ developers:
   - name: Calypso Networks Association Technical Team
     email: [email protected]
 scm:
-  connection: scm:git:git://github.com/calypsonet/calypsonet-terminal-calypso-java-api.git
-  developerConnection: scm:git:https://github.com/calypsonet/calypsonet-terminal-calypso-java-api.git
-  url: https://github.com/calypsonet/calypsonet-terminal-calypso-java-api
+  connection: scm:git:git://github.com/calypsonet/calypsonet-terminal-calypso-crypto-legacysam-java-api.git
+  developerConnection: scm:git:https://github.com/calypsonet/calypsonet-terminal-calypso-crypto-legacysam-java-api.git
+  url: https://github.com/calypsonet/calypsonet-terminal-calypso-crypto-legacysam-java-api
 ciManagement:
   system: GitHub Actions
-  url: https://github.com/calypsonet/calypsonet-terminal-calypso-java-api/actions
+  url: https://github.com/calypsonet/calypsonet-terminal-calypso-crypto-legacysam-java-api/actions

src/main/java/org/calypsonet/terminal/calypso/crypto/legacysam/sam/LegacySam.java

@@ -22,71 +22,71 @@
 public interface LegacySam extends SmartCard {
 
   /**
-   * Gets the SAM product type.
+   * Returns the SAM product type.
    *
    * @return The identified product type.
    * @since 0.1.0
    */
   ProductType getProductType();
 
   /**
-   * Gets a text description of the SAM.
+   * Returns a text description of the SAM.
    *
    * @return A not null String.
    * @since 0.1.0
    */
   String getProductInfo();
 
   /**
-   * Gets the SAM serial number as an array of bytes
+   * Returns the SAM serial number as an array of bytes
    *
    * @return A not null array of bytes
    * @since 0.1.0
    */
   byte[] getSerialNumber();
 
   /**
-   * Gets the platform identifier
+   * Returns the platform identifier
    *
    * @return A byte
    * @since 0.1.0
    */
   byte getPlatform();
 
   /**
-   * Gets the application type
+   * Returns the application type
    *
    * @return A byte
    * @since 0.1.0
    */
   byte getApplicationType();
 
   /**
-   * Gets the application subtype
+   * Returns the application subtype
    *
    * @return A byte
    * @since 0.1.0
    */
   byte getApplicationSubType();
 
   /**
-   * Gets the software issuer identifier
+   * Returns the software issuer identifier
    *
    * @return A byte
    * @since 0.1.0
    */
   byte getSoftwareIssuer();
 
   /**
-   * Gets the software version number
+   * Returns the software version number
    *
    * @return A byte
    * @since 0.1.0
    */
   byte getSoftwareVersion();
 
   /**
-   * Gets the software revision number
+   * Returns the software revision number
    *
    * @return A byte
    * @since 0.1.0
@@ -97,7 +97,7 @@ public interface LegacySam extends SmartCard {
    * Returns the value of an event counter.
    *
    * @param eventCounterNumber The number of the event counter (in range [0..26]).
-   * @return null if the event counter value is not set.
+   * @return Null if the event counter value is not set.
    * @since 0.1.0
    */
   Integer getEventCounter(int eventCounterNumber);
@@ -106,7 +106,7 @@ public interface LegacySam extends SmartCard {
    * Returns the value of known event counters in a sorted map where {@code key} is the counter
    * number and {@code value} is the counter value.
    *
-   * @return a not null map.
+   * @return A not null map.
    * @since 0.1.0
    */
   SortedMap<Integer, Integer> getEventCounters();
@@ -115,7 +115,7 @@ public interface LegacySam extends SmartCard {
    * Returns the value of an event ceiling.
    *
    * @param eventCeilingNumber The number of the event ceiling (in range [0..26]).
-   * @return null if the event ceiling value is not set.
+   * @return Null if the event ceiling value is not set.
    * @since 0.1.0
    */
   Integer getEventCeiling(int eventCeilingNumber);
@@ -124,7 +124,7 @@ public interface LegacySam extends SmartCard {
    * Returns the value of known event ceilings in a sorted map where {@code key} is the ceiling
    * number and {@code value} is the ceiling value.
    *
-   * @return a not null map.
+   * @return A not null map.
    * @since 0.1.0
    */
   SortedMap<Integer, Integer> getEventCeilings();

src/main/java/org/calypsonet/terminal/calypso/crypto/legacysam/spi/LegacySamRevocationServiceSpi.java → src/main/java/org/calypsonet/terminal/calypso/crypto/legacysam/spi/LSRevocationServiceSpi.java

@@ -16,7 +16,7 @@
  *
  * @since 0.1.0
  */
-public interface LegacySamRevocationServiceSpi {
+public interface LSRevocationServiceSpi {
 
   /**
    * Checks if the SAM with the provided serial number is revoked or not.

src/main/java/org/calypsonet/terminal/calypso/crypto/legacysam/spi/package-info.java

@@ -1,5 +1,5 @@
 /**
- * Handlers to be implemented by end user applications.
+ * Handlers to be implemented by end user application.
  *
  * @since 0.1.0
  */

src/main/java/org/calypsonet/terminal/calypso/crypto/legacysam/transaction/InvalidSignatureException.java

@@ -12,11 +12,7 @@
 package org.calypsonet.terminal.calypso.crypto.legacysam.transaction;
 
 /**
- * Indicates that a signature is incorrect. This can happen in the following cases:
- *
- * <ul>
- *   <li>The "PSO Verify Signature" SAM command status is 6988h;
- * </ul>
+ * Indicates that a signature is invalid.
  *
  * @since 0.1.0
  */

src/main/java/org/calypsonet/terminal/calypso/crypto/legacysam/transaction/LSCommandDataFactory.java

@@ -12,7 +12,7 @@
 package org.calypsonet.terminal.calypso.crypto.legacysam.transaction;
 
 /**
- * Factory of all complex command in/out data.
+ * Factory of all input/output data of complex commands.
  *
  * @since 0.1.0
  */

src/main/java/org/calypsonet/terminal/calypso/crypto/legacysam/transaction/LSTransactionManagerFactory.java

@@ -22,12 +22,12 @@
 public interface LSTransactionManagerFactory {
 
   /**
-   * Creates an instance of {@link LSFreeTransactionManager}
+   * Creates an instance of {@link LSFreeTransactionManager}.
    *
    * @param samReader The reader to use to communicate with the SAM.
    * @param sam The SAM image.
    * @return A new instance of {@link LSFreeTransactionManager}.
-   * @throws IllegalArgumentException If one the arguments is null.
+   * @throws IllegalArgumentException If an argument is null.
    * @since 0.1.0
    */
   LSFreeTransactionManager createFreeTransactionManager(CardReader samReader, LegacySam sam);

src/main/java/org/calypsonet/terminal/calypso/crypto/legacysam/transaction/TraceableSignatureVerificationData.java

@@ -11,7 +11,7 @@
  ************************************************************************************** */
 package org.calypsonet.terminal.calypso.crypto.legacysam.transaction;
 
-import org.calypsonet.terminal.calypso.crypto.legacysam.spi.LegacySamRevocationServiceSpi;
+import org.calypsonet.terminal.calypso.crypto.legacysam.spi.LSRevocationServiceSpi;
 
 /**
  * Contains the input/output data of the {@link
@@ -40,9 +40,7 @@ public interface TraceableSignatureVerificationData
    * @since 0.1.0
    */
   TraceableSignatureVerificationData withSamTraceabilityMode(
-      int offset,
-      boolean isPartialSamSerialNumber,
-      LegacySamRevocationServiceSpi samRevocationService);
+      int offset, boolean isPartialSamSerialNumber, LSRevocationServiceSpi samRevocationService);
 
   /**
    * Indicates that the signature has been computed in non "Busy" mode.