GOPHERSPACE.DE - P H O X Y
gophering on raymii.org
This is a text-only version of the following page on https://raymii.org:
---
Title       :  Nagios plugin to check Safenet HSM
Author      :  Remy van Elst
Date        :  03-05-2013
URL         :  https://raymii.org/s/software/Nagios_Plugin_to_check_a_Safenet_HSM.html
Format      :  Markdown/HTML
---



This is a Nagios plugin to monitor a Safenet Protectserver HSM using the Safenet
tools. It can also gather information about the device, like firmware and
functional module information.

 Consider sponsoring me on Github. It means the world to me if you show you
r appreciation and you'll help pay the server costs.

 Y
ou can also sponsor me by getting a Digital Ocean VPS. With this referral link you'll get $100 credit for 60 days. 
 >


### Usage

    
    
    usage: ./hsm.sh options
    
    This script checks various safenet HSM things and outputs nagios style results.
    
    OPTIONS:
       -h      Show this message
       -t      Check type: "battery", "RAM", "datetime", "eventlog", "initialized", "hsminfo", "fminfo"
       -n      HSM name for $ET_HSM_NETCLIENT_SERVERLIST.
       -b      ctcheck binary (default: /opt/PTK/bin/ctcheck)
    
    CHECKS:
       battery          Show HSM Battery status, GOOD (ok) or LOW (crit)
       ram              HSM RAM, (ok) if <75% used, (warn) >75% <85% used, (crit) if >85% used.
       datetime         Local HSM date/time, (crit) if different from host time, host should use ntp in same timezone.
       eventlog         (ok) if eventlog not full, (crit) if eventlog full.
       initialized      (ok) if initialized, (crit) if not. Documentation states that a FALSE could mean a tampered device.
       hsminfo          always (ok), returns general HSM info, model, version, firmware and such.
       fminfo           always (ok), returns Functional Module information.
    

### Examples

    
    
    user@host ~$ ./hsm.sh -n hsm-038 -t ram
    OK: RAM Usage OK: 41% used, ( 10192256 total). HSM: hsm-038.
    user@host ~$ ./hsm.sh -n hsm-038 -t datetime
    OK: HSM: hsm-038 time is the same as local time: 15/04/2013 12:48.
    user@host ~$ ./hsm.sh -n hsm-038 -t eventlog
    OK: HSM: hsm-038 Event Log Count: 11
    user@host ~$ ./hsm.sh -n hsm-038 -t initialized
    OK: HSM: hsm-038 is initialized. All is well.
    user@host ~$ ./hsm.sh -n hsm-038 -t hsminfo
    OK: HSM: hsm-038; Serial Number:[...]; Model: [...]; Device Revision: F; Firmware Revision: [...]; Manufacturing Date: [...
]; Device Batch: [...]; PTKC Revision: [...]; Slot Count: [...] Security Mode: [...]; Transport Mode:[...]; Event Log Count: 88
.
    user@host ~$ ./hsm.sh -n hsm-038 -t battery
    OK: Battery status is good for HSM: hsm-038
    

### Download

[Either via Github][2] or [from this website][3]

   [1]: https://www.digitalocean.com/?refcode=7435ae6b8212
   [2]: https://github.com/RaymiiOrg/nagios
   [3]: https://raymii.org/s/inc/software/check_hsm.sh

---

License:
All the text on this website is free as in freedom unless stated otherwise. 
This means you can use it in any way you want, you can copy it, change it 
the way you like and republish it, as long as you release the (modified) 
content under the same license to give others the same freedoms you've got 
and place my name and a link to this site with the article as source.

This site uses Google Analytics for statistics and Google Adwords for 
advertisements. You are tracked and Google knows everything about you. 
Use an adblocker like ublock-origin if you don't want it.

All the code on this website is licensed under the GNU GPL v3 license 
unless already licensed under a license which does not allows this form 
of licensing or if another license is stated on that page / in that software:

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see .

Just to be clear, the information on this website is for ment for educational 
purposes and you use it at your own risk. I do not take responsibility if you 
screw something up. Use common sense, do not rm -rf / as root for example. 
If you have any questions then do not hesitate to contact me.

See https://raymii.org/s/static/About.html for details.