OpenNMS

add a new capsd plugin and poller plugin to monitor the SSL Certification Expiration

Details

Description

I created a capsd plugin and a poller plugin to monitor the SSL Certification Expiration.
Configuration example:
capsd-configuration.xml:

  <protocol-plugin protocol="SSLCert" class-name="org.opennms.netmgt.capsd.plugins.SSLCertPlugin" scan="on">
      <property key="port" value="443" />
      <property key="timeout" value="5000" />
      <property key="retry" value="1" />
  </protocol-plugin>

The capsd plugin will check whether the node has a SSL Certification.


       <service name="SSLCert" interval="300000"
            user-defined="false" status="on">
            <parameter key="retry" value="2"/>
            <parameter key="timeout" value="3000"/>
            <parameter key="port" value="443"/>
            <parameter key="expired" value="15"/>
        </service>

<monitor service="SSLCert" class-name="org.opennms.netmgt.poller.monitors.SSLCertMonitor"/>

This poller monitor has a parameter "expired". When the SSL certification will expire in the number of days of "expired" parameter. The service will be down.
  1. Text File
    0001-NMS-4142-Add-SSLCert-capsd-plugin-and-poller-monitor.patch
    22/Dec/12 12:31 PM
    28 kB
    Ron Roskens
  2. Java Source File
    SSLCertMonitor.java
    15/Sep/10 4:25 AM
    6 kB
    Joey Zhang
  3. Java Source File
    SSLCertPlugin.java
    15/Sep/10 4:24 AM
    1 kB
    Joey Zhang

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Joey Zhang added a comment -

Created an attachment (id=1085)
Capsd plugin for SSL Certification

Show
Joey Zhang added a comment - Created an attachment (id=1085) Capsd plugin for SSL Certification
Hide
Permalink
Joey Zhang added a comment -

Created an attachment (id=1086)
Poller plugin for SSL certification expiration monitor

Show
Joey Zhang added a comment - Created an attachment (id=1086) Poller plugin for SSL certification expiration monitor
Hide
Permalink
Matt Brozowski added a comment -

Hey Joey,

Do we have a signed OpenNMS Contributors Agreement for this? Do you mind filling one out?

http://www.opennms.org/wiki/Contributor_Agreement

Thanks for the contribution!

Show
Matt Brozowski added a comment - Hey Joey, Do we have a signed OpenNMS Contributors Agreement for this? Do you mind filling one out? http://www.opennms.org/wiki/Contributor_Agreement Thanks for the contribution!
Hide
Permalink
Seth Leger added a comment -

Deferring to 1.11.

Show
Seth Leger added a comment - Deferring to 1.11.
Hide
Permalink
Tim Miller Dyck added a comment -

Hello Joey Zhang,

This would be a helpful feature addition and I was excited to see someone had contributed this code.

If you are still reachable and can fill out the contributors agreement, that would be appreciated! Thanks!

-Tim Miller Dyck

Show
Tim Miller Dyck added a comment - Hello Joey Zhang, This would be a helpful feature addition and I was excited to see someone had contributed this code. If you are still reachable and can fill out the contributors agreement, that would be appreciated! Thanks! -Tim Miller Dyck
Hide
Permalink
UxBoD added a comment -

as the OP appears to have become unreachable is it possible for somebody to inherit the code and fill out a ONMS Contributors Agreement ? It would be great for the OPs code not to go too waste. Obviously with credit to original OP.

Show
UxBoD added a comment - as the OP appears to have become unreachable is it possible for somebody to inherit the code and fill out a ONMS Contributors Agreement ? It would be great for the OPs code not to go too waste. Obviously with credit to original OP.
Hide
Permalink
Steve Madel added a comment -

Where would I drop these java files in to start using them?

Show
Steve Madel added a comment - Where would I drop these java files in to start using them?
Hide
Permalink
Jeff Gehlbach added a comment -

UxBoD, it's unfortunately not as simple as somebody "inheriting" the code. Since Joey wrote the code and provided no copyright or licensing direction, we must treat it as "all rights reserved" until somebody can contact him to learn his intentions.

Show
Jeff Gehlbach added a comment - UxBoD, it's unfortunately not as simple as somebody "inheriting" the code. Since Joey wrote the code and provided no copyright or licensing direction, we must treat it as "all rights reserved" until somebody can contact him to learn his intentions.
Hide
Permalink
Ron Roskens added a comment -

New implementation of SSLCertPlugin and SSLCertMonitor.

For the SSLCertMonitor, instead of the parameter key "expired", I chose "days". The poll status message will change based on the current time being evaluated. So different unavailable messages if the certificate is not yet valid, will expire within X days, or has expired.

Included in this new patch are JUnit test cases for both the capsd plugin and poller monitor. The poller monitor test cases use the JUnitHttpServer annotation to provide a tcp socket that has an SSL certificate attached to it.

I did start to take a look at what it would take to implement a SSLCert detector using the provisioning framework, but quickly found it quite a bit harder to understand than the interfaces for Capsd and Pollerd.

Show
Ron Roskens added a comment - New implementation of SSLCertPlugin and SSLCertMonitor. For the SSLCertMonitor, instead of the parameter key "expired", I chose "days". The poll status message will change based on the current time being evaluated. So different unavailable messages if the certificate is not yet valid, will expire within X days, or has expired. Included in this new patch are JUnit test cases for both the capsd plugin and poller monitor. The poller monitor test cases use the JUnitHttpServer annotation to provide a tcp socket that has an SSL certificate attached to it. I did start to take a look at what it would take to implement a SSLCert detector using the provisioning framework, but quickly found it quite a bit harder to understand than the interfaces for Capsd and Pollerd.
Hide
Permalink
UxBoD added a comment -

@Ron: how would one go about applying your implementation please ?

Show
UxBoD added a comment - @Ron: how would one go about applying your implementation please ?
Hide
Permalink
Ron Roskens added a comment -

The patch file was created using 'git format-patch -M -C HEAD~1', so you could either:

cd $OPENNMS_SRC
git am < 0001-NMS-4142-Add-SSLCert-capsd-plugin-and-poller-monitor.patch

or

patch p1 < 0001NMS-4142-Add-SSLCert-capsd-plugin-and-poller-monitor.patch

then build like normal, using the instructions at http://www.opennms.org/wiki/Installation:Source

Show
Ron Roskens added a comment - The patch file was created using 'git format-patch -M -C HEAD~1', so you could either: cd $OPENNMS_SRC git am < 0001- NMS-4142 -Add-SSLCert-capsd-plugin-and-poller-monitor.patch or patch p1 < 0001 NMS-4142 -Add-SSLCert-capsd-plugin-and-poller-monitor.patch then build like normal, using the instructions at http://www.opennms.org/wiki/Installation:Source
Hide
Permalink
Tim Miller Dyck added a comment -

Ron, thank you for creating the feature from scratch! This would be great to include in the upcoming 1.12 release.

Show
Tim Miller Dyck added a comment - Ron, thank you for creating the feature from scratch! This would be great to include in the upcoming 1.12 release.
Hide
Permalink
Benjamin Reed added a comment -

I've already allowed too much churn in 1.11.90 trying to get it out, but I've gone ahead and merged this so it's available in the next beta/RC, 1.11.91.

Show
Benjamin Reed added a comment - I've already allowed too much churn in 1.11.90 trying to get it out, but I've gone ahead and merged this so it's available in the next beta/RC, 1.11.91.
Hide
Permalink
Benjamin Reed added a comment -

oh, and thanks for the updated patch

Show
Benjamin Reed added a comment - oh, and thanks for the updated patch

People

  • Assignee:
    Benjamin Reed
    Reporter:
    Joey Zhang
Vote (4)
Watch (9)

Dates

  • Created:
    Updated:
    Resolved: