imporve methods

Thumimku · Nov 15, 2023 · ed7feb9 · ed7feb9
1 parent 2b0ad60
commit ed7feb9
Showing 1 changed file with 25 additions and 4 deletions.
diff --git a/...carbon/identity/client/attestation/mgt/internal/ClientAttestationMgtServiceComponent.java b/...carbon/identity/client/attestation/mgt/internal/ClientAttestationMgtServiceComponent.java
@@ -74,34 +74,49 @@ protected void activate(ComponentContext context) {
         }
     }
 
+    /**
+     * Loads configurations for the Client Attestation Service.
+     */
     private void loadConfigs() {
 
+        // Set the Apple attestation root certificate and revocation check status
         ClientAttestationMgtDataHolder.getInstance()
                 .setAppleAttestationRootCertificate(getAppleAttestationRootCertificate());
         ClientAttestationMgtDataHolder.getInstance()
                 .setAppleAttestationRevocationCheckEnabled(loadAppleAttestationRevocationCheckEnabled());
-
     }
 
+    /**
+     * Loads the status of Apple attestation revocation check from the configuration.
+     *
+     * @return True if revocation check is enabled, false otherwise.
+     */
     private boolean loadAppleAttestationRevocationCheckEnabled() {
 
         return Boolean.parseBoolean(IdentityUtil.getProperty(APPLE_ATTESTATION_REVOCATION_CHECK_ENABLED));
     }
 
-
+    /**
+     * Retrieves the Apple attestation root certificate from the configured file path.
+     *
+     * @return The Apple attestation root certificate, or null if not found.
+     */
     private X509Certificate getAppleAttestationRootCertificate() {
 
         try {
             String appleAttestationRootCertificatePath =
                     IdentityUtil.getProperty(APPLE_ATTESTATION_ROOT_CERTIFICATE_PATH);
+
             if (StringUtils.isNotBlank(appleAttestationRootCertificatePath)) {
                 CertificateFactory certificateFactory = CertificateFactory.getInstance("X509");
                 FileInputStream fileInputStream = new FileInputStream(appleAttestationRootCertificatePath);
                 X509Certificate appleAttestationRootCertificate =
                         (X509Certificate) certificateFactory.generateCertificate(fileInputStream);
+
+                // Warn if the certificate is expiring soon
                 if (isCertificateExpiringSoon(appleAttestationRootCertificate)) {
                     LOG.warn("Provided apple attestation root certificate is going to expire soon. " +
-                            "Please add latest certificate.");
+                            "Please add the latest certificate.");
                 }
                 return appleAttestationRootCertificate;
             } else {
@@ -113,6 +128,12 @@ private X509Certificate getAppleAttestationRootCertificate() {
         return null;
     }
 
+    /**
+     * Checks if the given X.509 certificate is expiring within 30 days.
+     *
+     * @param certificate The X.509 certificate to check.
+     * @return True if the certificate is expiring soon, false otherwise.
+     */
     private boolean isCertificateExpiringSoon(X509Certificate certificate) {
 
         Date currentDate = new Date();
@@ -121,7 +142,7 @@ private boolean isCertificateExpiringSoon(X509Certificate certificate) {
         // Calculate the difference in days
         long differenceInDays = (expirationDate.getTime() - currentDate.getTime()) / (24 * 60 * 60 * 1000);
 
-        // Check if the certificate is expiring within month.
+        // Check if the certificate is expiring within a month
         return differenceInDays <= 30;
     }