1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
|
/*
* Utility functions for tests that use remctl.
*
* Provides functions to start and stop a remctl daemon that uses the test
* Kerberos environment and runs on port 14373 instead of the default 4373.
*
* The canonical version of this file is maintained in the rra-c-util package,
* which can be found at <https://www.eyrie.org/~eagle/software/rra-c-util/>.
*
* Written by Russ Allbery <eagle@eyrie.org>
* Copyright 2006-2007, 2009, 2011-2013
* The Board of Trustees of the Leland Stanford Junior University
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
* SPDX-License-Identifier: MIT
*/
#ifndef TAP_REMCTL_H
#define TAP_REMCTL_H 1
#include <config.h>
#include <tests/tap/macros.h>
#include <sys/types.h> /* pid_t */
/* Defined in <tests/tap/kerberos.h>. */
struct kerberos_config;
/* Opaque struct with process tracking data. */
struct process;
BEGIN_DECLS
/*
* Start remctld for tests that use it. kerberos_setup should normally be
* called first to check whether a Kerberos configuration is available and to
* set KRB5_KTNAME. Takes the Kerberos configuration, the path to the
* configuration file, and then any additional arguments to remctld,
* terminated by NULL.
*
* process_stop (from <tests/tap/process.h> can be called explicitly to stop
* remctld and clean up, but it will also be stopped automatically at the end
* of the test program, so tests that only start and stop the server once can
* just let cleanup happen automatically.
*
* PATH_REMCTLD must be defined, either with explicit compiler options or in
* config.h. If it's not defined, remctld_start calls skip_all, assuming that
* this means that the test case cannot be run.
*/
struct process *remctld_start(struct kerberos_config *, const char *config,
...) __attribute__((__nonnull__(1, 2)));
/*
* Like remctld_start, but run remctld under fakeroot. Calls skip_all if
* PATH_FAKEROOT is not defined, either with explicit compiler options or in
* config.h.
*/
struct process *remctld_start_fakeroot(struct kerberos_config *,
const char *config, ...)
__attribute__((__nonnull__(1, 2)));
END_DECLS
#endif /* !TAP_REMCTL_H */
|