rcode.h

Go to the documentation of this file.

#pragma once
/*
 *  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 2 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, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
/**
 * $Id: b4915b7926ffa5c8bff5ad13c991a86510c8bda4 $
 *
 * @file lib/server/rcode.h
 * @brief Return codes returned by modules and virtual server sections
 *
 * @copyright 2018 The FreeRADIUS server project
 */
RCSIDH(rcode_h, "$Id: b4915b7926ffa5c8bff5ad13c991a86510c8bda4 $")
 
#include <freeradius-devel/util/table.h>
#include <freeradius-devel/unlang/action.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/** Return codes indicating the result of the module call
 *
 * All module functions must return one of the codes listed below (apart from
 * RLM_MODULE_NUMCODES, which is used to check for validity).
 *
 *  When updating this, be sure to check everything using #fr_process_rcode_t, rcode_table, and
 *  everything which references RLM_MODULE_NUMCODES.  e.g. foo [RLM_MODULE_NUMCODES];
 
 */
typedef enum : uint8_t {
        RLM_MODULE_NOT_SET = 0,                         //!< Error resolving rcode (should not be
                                                        //!< returned by modules).
        RLM_MODULE_REJECT,                              //!< Immediately reject the request.
        RLM_MODULE_FAIL,                                //!< Module failed, don't reply.
        RLM_MODULE_OK,                                  //!< The module is OK, continue.
        RLM_MODULE_HANDLED,                             //!< The module handled the request, so stop.
        RLM_MODULE_INVALID,                             //!< The module considers the request invalid.
        RLM_MODULE_DISALLOW,                            //!< Reject the request (user is locked out).
        RLM_MODULE_NOTFOUND,                            //!< User not found.
        RLM_MODULE_NOOP,                                //!< Module succeeded without doing anything.
        RLM_MODULE_UPDATED,                             //!< OK (pairs modified).
        RLM_MODULE_TIMEOUT,                             //!< Module (or section) timed out.
        RLM_MODULE_NUMCODES,                            //!< How many valid return codes there are.
} rlm_rcode_t;
 
/** Whether an integer is an rcode which a module may return
 *
 * RLM_MODULE_NOT_SET and RLM_MODULE_NUMCODES are not rcodes which a module may return.
 */
#define RLM_MODULE_RCODE_VALID(_rcode) (((_rcode) > RLM_MODULE_NOT_SET) && ((_rcode) < RLM_MODULE_NUMCODES))
 
 
#define RETURN_UNLANG_RCODE(_rcode)     do { p_result->rcode = (_rcode); return UNLANG_ACTION_CALCULATE_RESULT; } while (0)
#define RETURN_UNLANG_REJECT            RETURN_UNLANG_RCODE(RLM_MODULE_REJECT)
#define RETURN_UNLANG_FAIL              RETURN_UNLANG_RCODE(RLM_MODULE_FAIL)
#define RETURN_UNLANG_OK                RETURN_UNLANG_RCODE(RLM_MODULE_OK)
#define RETURN_UNLANG_HANDLED           RETURN_UNLANG_RCODE(RLM_MODULE_HANDLED)
#define RETURN_UNLANG_INVALID           RETURN_UNLANG_RCODE(RLM_MODULE_INVALID)
#define RETURN_UNLANG_DISALLOW          RETURN_UNLANG_RCODE(RLM_MODULE_DISALLOW)
#define RETURN_UNLANG_NOTFOUND          RETURN_UNLANG_RCODE(RLM_MODULE_NOTFOUND)
#define RETURN_UNLANG_NOOP              RETURN_UNLANG_RCODE(RLM_MODULE_NOOP)
#define RETURN_UNLANG_UPDATED           RETURN_UNLANG_RCODE(RLM_MODULE_UPDATED)
#define RETURN_UNLANG_TIMEOUT           RETURN_UNLANG_RCODE(RLM_MODULE_TIMEOUT)
 
extern fr_table_num_sorted_t const rcode_table[];
extern size_t rcode_table_len;
 
/** Rcodes that translate to a user configurable section failing overall
 *
 */
#define RLM_MODULE_USER_SECTION_REJECT  \
        RLM_MODULE_REJECT:              \
        case RLM_MODULE_FAIL:           \
        case RLM_MODULE_INVALID:        \
        case RLM_MODULE_DISALLOW:       \
        case RLM_MODULE_TIMEOUT
 
#ifdef __cplusplus
}
#endif