|
Packit |
fd8b60 |
/* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Copyright 2013 Red Hat, Inc. All rights reserved.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* Redistribution and use in source and binary forms, with or without
|
|
Packit |
fd8b60 |
* modification, are permitted provided that the following conditions are met:
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* 1. Redistributions of source code must retain the above copyright
|
|
Packit |
fd8b60 |
* notice, this list of conditions and the following disclaimer.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* 2. Redistributions in binary form must reproduce the above copyright
|
|
Packit |
fd8b60 |
* notice, this list of conditions and the following disclaimer in
|
|
Packit |
fd8b60 |
* the documentation and/or other materials provided with the
|
|
Packit |
fd8b60 |
* distribution.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
|
|
Packit |
fd8b60 |
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
Packit |
fd8b60 |
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
|
|
Packit |
fd8b60 |
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
|
|
Packit |
fd8b60 |
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
Packit |
fd8b60 |
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
Packit |
fd8b60 |
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
Packit |
fd8b60 |
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
Packit |
fd8b60 |
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
Packit |
fd8b60 |
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
Packit |
fd8b60 |
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* This API is not considered as stable as the main krb5 API.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* - We may make arbitrary incompatible changes between feature releases
|
|
Packit |
fd8b60 |
* (e.g. from 1.12 to 1.13).
|
|
Packit |
fd8b60 |
* - We will make some effort to avoid making incompatible changes for
|
|
Packit |
fd8b60 |
* bugfix releases, but will make them if necessary.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
#ifndef KRAD_H_
|
|
Packit |
fd8b60 |
#define KRAD_H_
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
#include <krb5.h>
|
|
Packit |
fd8b60 |
#include <verto.h>
|
|
Packit |
fd8b60 |
#include <stddef.h>
|
|
Packit |
fd8b60 |
#include <stdio.h>
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
#define KRAD_PACKET_SIZE_MAX 4096
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
#define KRAD_SERVICE_TYPE_LOGIN 1
|
|
Packit |
fd8b60 |
#define KRAD_SERVICE_TYPE_FRAMED 2
|
|
Packit |
fd8b60 |
#define KRAD_SERVICE_TYPE_CALLBACK_LOGIN 3
|
|
Packit |
fd8b60 |
#define KRAD_SERVICE_TYPE_CALLBACK_FRAMED 4
|
|
Packit |
fd8b60 |
#define KRAD_SERVICE_TYPE_OUTBOUND 5
|
|
Packit |
fd8b60 |
#define KRAD_SERVICE_TYPE_ADMINISTRATIVE 6
|
|
Packit |
fd8b60 |
#define KRAD_SERVICE_TYPE_NAS_PROMPT 7
|
|
Packit |
fd8b60 |
#define KRAD_SERVICE_TYPE_AUTHENTICATE_ONLY 8
|
|
Packit |
fd8b60 |
#define KRAD_SERVICE_TYPE_CALLBACK_NAS_PROMPT 9
|
|
Packit |
fd8b60 |
#define KRAD_SERVICE_TYPE_CALL_CHECK 10
|
|
Packit |
fd8b60 |
#define KRAD_SERVICE_TYPE_CALLBACK_ADMINISTRATIVE 11
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
typedef struct krad_attrset_st krad_attrset;
|
|
Packit |
fd8b60 |
typedef struct krad_packet_st krad_packet;
|
|
Packit |
fd8b60 |
typedef struct krad_client_st krad_client;
|
|
Packit |
fd8b60 |
typedef unsigned char krad_code;
|
|
Packit |
fd8b60 |
typedef unsigned char krad_attr;
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Called when a response is received or the request times out. */
|
|
Packit |
fd8b60 |
typedef void
|
|
Packit |
fd8b60 |
(*krad_cb)(krb5_error_code retval, const krad_packet *request,
|
|
Packit |
fd8b60 |
const krad_packet *response, void *data);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Called to iterate over a set of requests. Either the callback will be
|
|
Packit |
fd8b60 |
* called until it returns NULL, or it will be called with cancel = TRUE to
|
|
Packit |
fd8b60 |
* terminate in the middle of an iteration.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
typedef const krad_packet *
|
|
Packit |
fd8b60 |
(*krad_packet_iter_cb)(void *data, krb5_boolean cancel);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Code
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Convert a code name to its number. Only works for codes defined
|
|
Packit |
fd8b60 |
* by RFC 2875 or 2882. Returns 0 if the name was not found. */
|
|
Packit |
fd8b60 |
krad_code
|
|
Packit |
fd8b60 |
krad_code_name2num(const char *name);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Convert a code number to its name. Only works for attributes defined
|
|
Packit |
fd8b60 |
* by RFC 2865 or 2882. Returns NULL if the name was not found. */
|
|
Packit |
fd8b60 |
const char *
|
|
Packit |
fd8b60 |
krad_code_num2name(krad_code code);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Attribute
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Convert an attribute name to its number. Only works for attributes defined
|
|
Packit |
fd8b60 |
* by RFC 2865. Returns 0 if the name was not found. */
|
|
Packit |
fd8b60 |
krad_attr
|
|
Packit |
fd8b60 |
krad_attr_name2num(const char *name);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Convert an attribute number to its name. Only works for attributes defined
|
|
Packit |
fd8b60 |
* by RFC 2865. Returns NULL if the name was not found. */
|
|
Packit |
fd8b60 |
const char *
|
|
Packit |
fd8b60 |
krad_attr_num2name(krad_attr type);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Attribute set
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Create a new attribute set. */
|
|
Packit |
fd8b60 |
krb5_error_code
|
|
Packit |
fd8b60 |
krad_attrset_new(krb5_context ctx, krad_attrset **set);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Create a deep copy of an attribute set. */
|
|
Packit |
fd8b60 |
krb5_error_code
|
|
Packit |
fd8b60 |
krad_attrset_copy(const krad_attrset *set, krad_attrset **copy);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Free an attribute set. */
|
|
Packit |
fd8b60 |
void
|
|
Packit |
fd8b60 |
krad_attrset_free(krad_attrset *set);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Add an attribute to a set. */
|
|
Packit |
fd8b60 |
krb5_error_code
|
|
Packit |
fd8b60 |
krad_attrset_add(krad_attrset *set, krad_attr type, const krb5_data *data);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Add a four-octet unsigned number attribute to the given set. */
|
|
Packit |
fd8b60 |
krb5_error_code
|
|
Packit |
fd8b60 |
krad_attrset_add_number(krad_attrset *set, krad_attr type, krb5_ui_4 num);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Delete the specified attribute. */
|
|
Packit |
fd8b60 |
void
|
|
Packit |
fd8b60 |
krad_attrset_del(krad_attrset *set, krad_attr type, size_t indx);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Get the specified attribute. */
|
|
Packit |
fd8b60 |
const krb5_data *
|
|
Packit |
fd8b60 |
krad_attrset_get(const krad_attrset *set, krad_attr type, size_t indx);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Packet
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Determine the bytes needed from the socket to get the whole packet. Don't
|
|
Packit |
fd8b60 |
* cache the return value as it can change! Returns -1 on EBADMSG. */
|
|
Packit |
fd8b60 |
ssize_t
|
|
Packit |
fd8b60 |
krad_packet_bytes_needed(const krb5_data *buffer);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Free a packet. */
|
|
Packit |
fd8b60 |
void
|
|
Packit |
fd8b60 |
krad_packet_free(krad_packet *pkt);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Create a new request packet.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* This function takes the attributes specified in set and converts them into a
|
|
Packit |
fd8b60 |
* radius packet. The packet will have a randomized id. If cb is not NULL, it
|
|
Packit |
fd8b60 |
* will be called passing data as the argument to iterate over a set of
|
|
Packit |
fd8b60 |
* outstanding requests. In this case, the id will be both random and unique
|
|
Packit |
fd8b60 |
* across the set of requests.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
krb5_error_code
|
|
Packit |
fd8b60 |
krad_packet_new_request(krb5_context ctx, const char *secret, krad_code code,
|
|
Packit |
fd8b60 |
const krad_attrset *set, krad_packet_iter_cb cb,
|
|
Packit |
fd8b60 |
void *data, krad_packet **request);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Create a new response packet.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* This function is similar to krad_packet_new_requst() except that it crafts a
|
|
Packit |
fd8b60 |
* packet in response to a request packet. This new packet will borrow values
|
|
Packit |
fd8b60 |
* from the request such as the id and the authenticator.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
krb5_error_code
|
|
Packit |
fd8b60 |
krad_packet_new_response(krb5_context ctx, const char *secret, krad_code code,
|
|
Packit |
fd8b60 |
const krad_attrset *set, const krad_packet *request,
|
|
Packit |
fd8b60 |
krad_packet **response);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Decode a request radius packet from krb5_data.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* The resulting decoded packet will be a request packet stored in *reqpkt.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* If cb is NULL, *duppkt will always be NULL.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* If cb is not NULL, it will be called (with the data argument) to iterate
|
|
Packit |
fd8b60 |
* over a set of requests currently being processed. In this case, if the
|
|
Packit |
fd8b60 |
* packet is a duplicate of an already received request, the original request
|
|
Packit |
fd8b60 |
* will be set in *duppkt.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
krb5_error_code
|
|
Packit |
fd8b60 |
krad_packet_decode_request(krb5_context ctx, const char *secret,
|
|
Packit |
fd8b60 |
const krb5_data *buffer, krad_packet_iter_cb cb,
|
|
Packit |
fd8b60 |
void *data, const krad_packet **duppkt,
|
|
Packit |
fd8b60 |
krad_packet **reqpkt);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Decode a response radius packet from krb5_data.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* The resulting decoded packet will be a response packet stored in *rsppkt.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* If cb is NULL, *reqpkt will always be NULL.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* If cb is not NULL, it will be called (with the data argument) to iterate
|
|
Packit |
fd8b60 |
* over a set of requests awaiting responses. In this case, if the response
|
|
Packit |
fd8b60 |
* packet matches one of these requests, the original request will be set in
|
|
Packit |
fd8b60 |
* *reqpkt.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
krb5_error_code
|
|
Packit |
fd8b60 |
krad_packet_decode_response(krb5_context ctx, const char *secret,
|
|
Packit |
fd8b60 |
const krb5_data *buffer, krad_packet_iter_cb cb,
|
|
Packit |
fd8b60 |
void *data, const krad_packet **reqpkt,
|
|
Packit |
fd8b60 |
krad_packet **rsppkt);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Encode packet. */
|
|
Packit |
fd8b60 |
const krb5_data *
|
|
Packit |
fd8b60 |
krad_packet_encode(const krad_packet *pkt);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Get the code for the given packet. */
|
|
Packit |
fd8b60 |
krad_code
|
|
Packit |
fd8b60 |
krad_packet_get_code(const krad_packet *pkt);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Get the specified attribute. */
|
|
Packit |
fd8b60 |
const krb5_data *
|
|
Packit |
fd8b60 |
krad_packet_get_attr(const krad_packet *pkt, krad_attr type, size_t indx);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Client
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Create a new client. */
|
|
Packit |
fd8b60 |
krb5_error_code
|
|
Packit |
fd8b60 |
krad_client_new(krb5_context kctx, verto_ctx *vctx, krad_client **client);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Free the client. */
|
|
Packit |
fd8b60 |
void
|
|
Packit |
fd8b60 |
krad_client_free(krad_client *client);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Send a request to a radius server.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* The remote host may be specified by one of the following formats:
|
|
Packit |
fd8b60 |
* - /path/to/unix.socket
|
|
Packit |
fd8b60 |
* - IPv4
|
|
Packit |
fd8b60 |
* - IPv4:port
|
|
Packit |
fd8b60 |
* - IPv4:service
|
|
Packit |
fd8b60 |
* - [IPv6]
|
|
Packit |
fd8b60 |
* - [IPv6]:port
|
|
Packit |
fd8b60 |
* - [IPv6]:service
|
|
Packit |
fd8b60 |
* - hostname
|
|
Packit |
fd8b60 |
* - hostname:port
|
|
Packit |
fd8b60 |
* - hostname:service
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* The timeout parameter (milliseconds) is the total timeout across all remote
|
|
Packit |
fd8b60 |
* hosts (when DNS returns multiple entries) and all retries. For stream
|
|
Packit |
fd8b60 |
* sockets, the retries parameter is ignored and no retries are performed.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* The cb function will be called with the data argument when either a response
|
|
Packit |
fd8b60 |
* is received or the request times out on all possible remote hosts.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
krb5_error_code
|
|
Packit |
fd8b60 |
krad_client_send(krad_client *rc, krad_code code, const krad_attrset *attrs,
|
|
Packit |
fd8b60 |
const char *remote, const char *secret, int timeout,
|
|
Packit |
fd8b60 |
size_t retries, krad_cb cb, void *data);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
#endif /* KRAD_H_ */
|