Add logging table

Removals and updates to certificates are logged in table `/apmg/strust_log`. 

Currently, only successful runs are saved. In case of errors, no log will be written.

When application logging will be added, we will also log errors.

Author: mbtools

src/#apmg#cl_strust.clas.abap

@@ -13,7 +13,7 @@ CLASS /apmg/cl_strust DEFINITION
 ************************************************************************
   PUBLIC SECTION.
 
-    CONSTANTS c_version TYPE string VALUE '2.0.2' ##NEEDED.
+    CONSTANTS c_version TYPE string VALUE '2.1.0' ##NEEDED.
 
     CONSTANTS:
       BEGIN OF c_context ##NEEDED,
@@ -113,14 +113,17 @@ CLASS /apmg/cl_strust DEFINITION
     METHODS remove
       IMPORTING
         !subject      TYPE string
+        !comment      TYPE string OPTIONAL
       RETURNING
         VALUE(result) TYPE REF TO /apmg/cl_strust
       RAISING
         /apmg/cx_error.
 
     METHODS update
       IMPORTING
+        !comment        TYPE string OPTIONAL
         !remove_expired TYPE abap_bool DEFAULT abap_false
+          PREFERRED PARAMETER comment
       RETURNING
         VALUE(result)   TYPE ty_certattr_tt
       RAISING
@@ -143,6 +146,7 @@ CLASS /apmg/cl_strust DEFINITION
       certs_new     TYPE ty_certattr_tt,
       cert_current  TYPE ty_certattr,
       certs_current TYPE ty_certattr_tt,
+      logs          TYPE STANDARD TABLE OF /apmg/strust_log WITH KEY timestamp counter,
       is_dirty      TYPE abap_bool.
 
     METHODS _create
@@ -168,6 +172,23 @@ CLASS /apmg/cl_strust DEFINITION
       RAISING
         /apmg/cx_error.
 
+    METHODS _log_add
+      IMPORTING
+        !subject   TYPE ty_certattr-subject
+        !issuer    TYPE ty_certattr-issuer
+        !date_from TYPE ty_certattr-date_from
+        !date_to   TYPE ty_certattr-date_to
+        !status    TYPE /apmg/strust_log-status
+        !message   TYPE /apmg/strust_log-message
+      RAISING
+        /apmg/cx_error.
+
+    METHODS _log_save
+      IMPORTING
+        !comment TYPE string
+      RAISING
+        /apmg/cx_error.
+
 ENDCLASS.
 
 
@@ -434,7 +455,7 @@ CLASS /apmg/cl_strust IMPLEMENTATION.
 
     _profile( ).
 
-    " Remove certificate
+    " Remove certificates
     LOOP AT certs_current ASSIGNING FIELD-SYMBOL(<cert>) WHERE subject = subject.
 
       CALL FUNCTION 'SSFC_REMOVECERTIFICATE'
@@ -456,13 +477,21 @@ CLASS /apmg/cl_strust IMPLEMENTATION.
         RAISE EXCEPTION TYPE /apmg/cx_error_t100.
       ENDIF.
 
+      _log_add(
+        subject   = <cert>-subject
+        issuer    = <cert>-issuer
+        date_from = <cert>-date_from
+        date_to   = <cert>-date_to
+        status    = icon_led_green
+        message   = 'Removed' ).
+
       is_dirty = abap_true.
 
     ENDLOOP.
 
     _save( ).
 
-    _unlock( ).
+    _log_save( comment ).
 
     result = me.
 
@@ -501,6 +530,14 @@ CLASS /apmg/cl_strust IMPLEMENTATION.
               RAISE EXCEPTION TYPE /apmg/cx_error_t100.
             ENDIF.
 
+            _log_add(
+              subject   = <cert>-subject
+              issuer    = <cert>-issuer
+              date_from = <cert>-date_from
+              date_to   = <cert>-date_to
+              status    = icon_led_green
+              message   = 'Removed' ).
+
             is_dirty = abap_true.
           ELSE.
             " Certificate already exists, no update necessary
@@ -512,7 +549,7 @@ CLASS /apmg/cl_strust IMPLEMENTATION.
       ENDLOOP.
     ENDIF.
 
-    " Add new certificates to PSE
+    " Add new certificates
     LOOP AT certs_new ASSIGNING <cert_new>.
 
       CALL FUNCTION 'SSFC_PUT_CERTIFICATE'
@@ -539,12 +576,21 @@ CLASS /apmg/cl_strust IMPLEMENTATION.
         RAISE EXCEPTION TYPE /apmg/cx_error_t100.
       ENDIF.
 
+      _log_add(
+        subject   = <cert_new>-subject
+        issuer    = <cert_new>-issuer
+        date_from = <cert_new>-date_from
+        date_to   = <cert_new>-date_to
+        status    = icon_led_green
+        message   = 'Added' ).
+
       is_dirty = abap_true.
+
     ENDLOOP.
 
     _save( ).
 
-    _unlock( ).
+    _log_save( comment ).
 
     result = certs_new.
 
@@ -621,6 +667,40 @@ CLASS /apmg/cl_strust IMPLEMENTATION.
   ENDMETHOD.
 
 
+  METHOD _log_add.
+
+    DATA(log) = VALUE /apmg/strust_log(
+      cert_subject = subject
+      cert_issues  = issuer
+      date_from    = date_from
+      date_to      = date_to
+      status       = status
+      message      = message ).
+
+    INSERT log INTO TABLE logs.
+
+  ENDMETHOD.
+
+
+  METHOD _log_save.
+
+    GET TIME STAMP FIELD DATA(timestamp).
+
+    LOOP AT logs ASSIGNING FIELD-SYMBOL(<log>).
+      <log>-timestamp = timestamp.
+      <log>-counter   = sy-tabix.
+      <log>-username  = sy-uname.
+      <log>-comments  = comment.
+    ENDLOOP.
+
+    INSERT /apmg/strust_log FROM TABLE logs.
+    IF sy-subrc <> 0.
+      RAISE EXCEPTION TYPE /apmg/cx_error_text EXPORTING text = 'Error saving comments to log table'(012).
+    ENDIF.
+
+  ENDMETHOD.
+
+
   METHOD _profile.
 
     IF tempfile IS NOT INITIAL.
@@ -680,6 +760,8 @@ CLASS /apmg/cl_strust IMPLEMENTATION.
       MESSAGE 'Certificate was saved successfully' TYPE 'S'.
     ENDIF.
 
+    _unlock( ).
+
   ENDMETHOD.
 
 

src/#apmg#cl_strust.clas.xml

@@ -24,6 +24,12 @@
      <ENTRY>Missing profile. Call &quot;load&quot; first</ENTRY>
      <LENGTH>80</LENGTH>
     </item>
+    <item>
+     <ID>I</ID>
+     <KEY>012</KEY>
+     <ENTRY>Error saving comments to log table</ENTRY>
+     <LENGTH>80</LENGTH>
+    </item>
     <item>
      <ID>I</ID>
      <KEY>020</KEY>

src/#apmg#cl_strust_cert_api.clas.abap

@@ -14,11 +14,17 @@ CLASS /apmg/cl_strust_cert_api DEFINITION
 ************************************************************************
   PUBLIC SECTION.
 
+    CONSTANTS:
+      c_api_host     TYPE string VALUE 'https://tools.abappm.com',
+      c_api_endpoint TYPE string VALUE '/api/v1/certificates'.
+
     CLASS-METHODS get_certificates
       IMPORTING
         !domain       TYPE string
         !ssl_id       TYPE ssfapplssl DEFAULT 'ANONYM'
         !debug        TYPE abap_bool DEFAULT abap_false
+        !host         TYPE string DEFAULT c_api_host
+        !endpoint     TYPE string DEFAULT c_api_endpoint
       RETURNING
         VALUE(result) TYPE string
       RAISING
@@ -27,13 +33,10 @@ CLASS /apmg/cl_strust_cert_api DEFINITION
   PROTECTED SECTION.
   PRIVATE SECTION.
 
-    CONSTANTS:
-      c_api_host     TYPE string VALUE 'https://tools.abappm.com',
-      c_api_endpoint TYPE string VALUE '/api/v1/certificates'.
-
     CLASS-METHODS _client
       IMPORTING
         ssl_id        TYPE ssfapplssl
+        host          TYPE string
         uri           TYPE string
       RETURNING
         VALUE(result) TYPE REF TO if_http_client
@@ -71,7 +74,8 @@ CLASS /apmg/cl_strust_cert_api IMPLEMENTATION.
 
     DATA(http_client) = _client(
       ssl_id = ssl_id
-      uri    = |{ c_api_endpoint }?domain={ query }| ).
+      host   = host
+      uri    = |{ endpoint }?domain={ query }| ).
 
     DATA(fetch_response) = _response( http_client ).
 
@@ -98,7 +102,7 @@ CLASS /apmg/cl_strust_cert_api IMPLEMENTATION.
 
     cl_http_client=>create_by_url(
       EXPORTING
-        url    = c_api_host
+        url    = host
         ssl_id = ssl_id
       IMPORTING
         client = result

src/#apmg#strust_installer.prog.abap

@@ -15,8 +15,17 @@ SELECTION-SCREEN END OF BLOCK b1.
 
 SELECTION-SCREEN BEGIN OF BLOCK b2 WITH FRAME TITLE TEXT-t02.
   PARAMETERS p_domain TYPE string OBLIGATORY LOWER CASE.
+  SELECTION-SCREEN SKIP.
+  PARAMETERS p_text TYPE string LOWER CASE.
 SELECTION-SCREEN END OF BLOCK b2.
 
+SELECTION-SCREEN BEGIN OF BLOCK b4 WITH FRAME TITLE TEXT-t04.
+  PARAMETERS:
+    p_ssl_id TYPE ssfappl DEFAULT 'ANONYM',
+    p_host   TYPE string OBLIGATORY LOWER CASE,
+    p_endpnt TYPE string OBLIGATORY LOWER CASE.
+SELECTION-SCREEN END OF BLOCK b4.
+
 SELECTION-SCREEN BEGIN OF BLOCK b3 WITH FRAME TITLE TEXT-t03.
   PARAMETERS:
     p_passwd TYPE string LOWER CASE,
@@ -31,12 +40,20 @@ INITIALIZATION.
     + cl_abap_pse=>authority_check( iv_activity = '02' )
     + cl_abap_pse=>authority_check( iv_activity = '06' ).
   IF subrc <> 0.
-    MESSAGE 'You are not authorized to update certificates' TYPE 'E'.
+    MESSAGE 'You are not authorized to install certificates' TYPE 'I' DISPLAY LIKE 'E'.
     STOP.
   ENDIF.
 
+  p_host   = /apmg/cl_strust_cert_api=>c_api_host.
+  p_endpnt = /apmg/cl_strust_cert_api=>c_api_endpoint.
+
 START-OF-SELECTION.
 
+  IF p_root IS INITIAL AND p_main IS INITIAL.
+    MESSAGE 'No certificates selected for installation' TYPE 'I' DISPLAY LIKE 'E'.
+    STOP.
+  ENDIF.
+
   CALL FUNCTION 'SSFPSE_PARAMETER'
     EXPORTING
       context       = p_cont
@@ -45,25 +62,29 @@ START-OF-SELECTION.
       pse_not_found = 1
       OTHERS        = 2.
   IF sy-subrc <> 0.
-    MESSAGE 'PSE not found' TYPE 'E'.
+    MESSAGE 'PSE not found' TYPE 'I' DISPLAY LIKE 'E'.
     STOP.
   ENDIF.
 
   TRY.
       DATA(strust) = /apmg/cl_strust=>create(
         context     = p_cont
         application = p_appl
-        password    = p_passwd ).
+        password    = p_passwd )->load( ).
     CATCH /apmg/cx_error INTO DATA(error).
-      MESSAGE error TYPE 'E'.
+      MESSAGE error TYPE 'I' DISPLAY LIKE 'E'.
       STOP.
   ENDTRY.
 
   WRITE: /'Domain:', p_domain COLOR COL_POSITIVE.
   SKIP.
 
   TRY.
-      DATA(json) = /apmg/cl_strust_cert_api=>get_certificates( p_domain ).
+      DATA(json) = /apmg/cl_strust_cert_api=>get_certificates(
+        ssl_id   = p_ssl_id
+        domain   = p_domain
+        host     = p_host
+        endpoint = p_endpnt ).
 
       TRY.
           DATA(ajson) = zcl_ajson=>parse( json ).
@@ -150,11 +171,7 @@ START-OF-SELECTION.
         WRITE: / 'Test run' COLOR COL_TOTAL, '(changes were not saved)'.
       ELSE.
 
-        " Load and lock
-        strust->load( ).
-
-        " Save changes
-        strust->update( ).
+        strust->update( comment = p_text ).
 
         WRITE / 'Certificates saved' COLOR COL_POSITIVE.
 

src/#apmg#strust_installer.prog.xml

@@ -28,6 +28,12 @@
      <ENTRY>Options</ENTRY>
      <LENGTH>17</LENGTH>
     </item>
+    <item>
+     <ID>I</ID>
+     <KEY>T04</KEY>
+     <ENTRY>API</ENTRY>
+     <LENGTH>80</LENGTH>
+    </item>
     <item>
      <ID>R</ID>
      <ENTRY>Trust Management: Certificate Installer</ENTRY>
@@ -51,6 +57,18 @@
      <ENTRY>Domain</ENTRY>
      <LENGTH>14</LENGTH>
     </item>
+    <item>
+     <ID>S</ID>
+     <KEY>P_ENDPNT</KEY>
+     <ENTRY>Endpoint</ENTRY>
+     <LENGTH>16</LENGTH>
+    </item>
+    <item>
+     <ID>S</ID>
+     <KEY>P_HOST</KEY>
+     <ENTRY>Host</ENTRY>
+     <LENGTH>12</LENGTH>
+    </item>
     <item>
      <ID>S</ID>
      <KEY>P_MAIN</KEY>
@@ -69,12 +87,24 @@
      <ENTRY>Add root/intermediate certs</ENTRY>
      <LENGTH>35</LENGTH>
     </item>
+    <item>
+     <ID>S</ID>
+     <KEY>P_SSL_ID</KEY>
+     <ENTRY>SSL ID</ENTRY>
+     <LENGTH>14</LENGTH>
+    </item>
     <item>
      <ID>S</ID>
      <KEY>P_TEST</KEY>
      <ENTRY>Test run</ENTRY>
      <LENGTH>16</LENGTH>
     </item>
+    <item>
+     <ID>S</ID>
+     <KEY>P_TEXT</KEY>
+     <ENTRY>Description of change</ENTRY>
+     <LENGTH>29</LENGTH>
+    </item>
    </TPOOL>
   </asx:values>
  </asx:abap>