Meinberg NTP Autokey Scripts

This page contains information and download links for our Autokey Tools script collection project. The project goal is to create a set of scripts that assist administrators to configure their NTP servers and clients to use the autokey features provided by NTP v4.

Please send comments and requests for modifications to Heiko Gerstung <heiko.gerstung@meinberg.de>

The current version of the scripts was tested on Linux machines. If you have the chance to test this on other operating systems, please do so and send me any bug or success reports.

Autokey Tools for Unix

ak_tools V0.10 for NTP v4

Software ak_tools.tgz

Description

The current version includes one multi-purpose script called ak_tools and a number of symbolic links to that tool. These symbolic links are simply used to tell ak_tool which function it should execute. Just call "ak_tool -h" to see a list of the implemented functions.

The script tries to read a few things out of the configuration file of ntp, namely the cryptopw and keysdir parameters. Per default it looks at /etc/ntp.conf, but the location of the configuration file can be specified with the -c option.
The following functions are implemented for the server:

server_create_pars
creates the necessary server parameters
server_create_groupkey
creates a groupkey for clients
server_update_pars
updates the server parameters (they are only valid for 12 months)
The following functions are implemented for the clients:

client_create_pars
creates the necessary client parameters
client_install_groupkey
installs a groupkey for a specific server on your client
client_update_pars
updates the client parameters (they are only valid for 12 months)

Usage

Note: Before using this software, you have to read the disclaimer (below). You are only allowed to use the software if you accept these terms and conditions.
The commands have to be used in the following order:

Create the crypto parameters on the server (server_create_pars)

Create the crypto parameters on each client (client_create_pars) - you have to specify a password here (which will be used in the next step)
Create the groupkeys for your clients (server_create_groupkey) - if you use different passwords on your clients, you need to repeat this step and create the groupkey multiple times - with each required password
Install the groupkeys on your clients (after you transferred them to the clients in a secure manner) - make sure that each clients gets the correct copy of the groupkey, with the right password
The server and client parameters are created with a validity of 12 months and have to be updated. This can be done with the client_update_pars and server_update_pars commands
A short help text describing the required and optional parameters can be requested by calling "[command] -h"

Disclaimer

This software is not intended to be used in a production enviroment and should be used for educational purposes only.
MEINBERG Funkuhren GmbH & Co. KG GIVES NO WARRANTIES AND MAKES NO REPRESENTATIONS, EITHER EXPRESS OR IMPLIED, FOR THE SOFTWARE AND/OR DOCUMENTATION PROVIDED ON THIS WEBSITE, INCLUDING, WITHOUT LIMITATION, WARRANTY OF MERCHANTABILITY AND/OR WARRANTY OF FITNESS FOR A PARTICULAR USE.