summaryrefslogtreecommitdiff
path: root/lib/libradsec-base.h
blob: 57a86ef3be7e61a8e573e2604328e0bf087689a7 (plain)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/** @file libradsec-minimal.h
    @brief Low level API for libradsec.  */

/* FIXME: License blurb goes here.  */

#include "libevent.h"

/* Example usage.  */
#if 0
{
  fd = rs_connect (address, psk);
  if (!fd)
    /* check errno */ ;
  n = read (fd, buf, buflen);
  struct rs_packet *p = rs_packet_new (buf, buflen, &count);
  if (!p)
    {
      if (count < 0)
	/* check errno */ ;
      else
	/* need another COUNT octets */ ;
    }
  else
    /* next unused octet is at buf+count */

  n = rs_packet_serialize (p, buf, buflen);
  if (n < 0)
    /* invalid packet */ ;
  else if (n == 0)
    /* out of buffer space */ ;
  else
    write (fd, buf, n);

  if (p)
    rs_packet_free(p);
  if (fd)
    rs_disconnect(fd);
}
#endif


/* Function prototypes.  */

/** Establish a connection.

    @param type Connection type.
    @param addr Network address to connect to.
    @param cred Credentials, or NULL.

    @return A file descriptor or -1 if an error occurred, in which
    case errno is set appropriately.  */
int rs_connect(enum rs_conn_type type,
	       const struct sockaddr_storage *addr,
	       const struct rs_credentials *cred);

/** Disconnect.

    @param fd File descriptor to close.

    @return 0 on success or -1 if an error occurred, in which case
    errno is set appropriately.  */
int rs_disconnect(int fd);

/** Allocate and initialize a packet from a buffer containing a packet
    as seen on the wire.  Free the packet using @a rs_packet_free().

    @param buf Buffer with on-the-wire data with packet.
    @param buflen Number of octets in @a buf.

    @param count Number of octets used in buffer, in case of
    successful construction of a packet (return !NULL) or number of
    octets needed for a complete packet (return NULL).

    @return Packet or NULL on error or not enough data in @a buf.  If
    return value is NULL and @a count is < 0, an error has occurred
    and errno is set appropriately.  If return value is NULL and @a
    count is > 0 it shows the number of bytes needed to complete the
    packet.  */
struct rs_packet *rs_packet_new(const uint8_t *buf,
				size_t buflen,
				ssize_t *count);

/** Free a packet that has been allocated by @a rs_packet_new().

    @param packet Packet to free.  */
void rs_packet_free(struct rs_packet *packet);

/** Serialize a packet.

    @param packet Packet to serialize.
    @param buf Buffer to store the serialized packet in.
    @param buflen Length of buffer.

    @return Number of bytes written to buf or 0 if the buffer wasn't
    large enough to hold the packet or < 0 in case the packet couldn't
    be serialized for some other eason (FIXME: elaborate) */

ssize_t rs_packet_serialize(const struct rs_packet *packet,
			    uint8_t *buf,
			    size_t buflen);