1/* $OpenBSD: talkd.h,v 1.5 2015/01/21 02:23:14 guenther Exp $ */
2/* $NetBSD: talkd.h,v 1.5 1995/03/04 07:59:30 cgd Exp $ */
3
4/*
5 * Copyright (c) 1983 Regents of the University of California.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 * @(#)talkd.h 5.7 (Berkeley) 4/3/91
33 */
34
35#ifndef _TALKD_H_
36#define _TALKD_H_
37
38/*
39 * This describes the protocol used by the talk server and clients.
40 *
41 * The talk server acts a repository of invitations, responding to
42 * requests by clients wishing to rendezvous for the purpose of
43 * holding a conversation. In normal operation, a client, the caller,
44 * initiates a rendezvous by sending a CTL_MSG to the server of
45 * type LOOK_UP. This causes the server to search its invitation
46 * tables to check if an invitation currently exists for the caller
47 * (to speak to the callee specified in the message). If the lookup
48 * fails, the caller then sends an ANNOUNCE message causing the server
49 * to broadcast an announcement on the callee's login ports requesting
50 * contact. When the callee responds, the local server uses the
51 * recorded invitation to respond with the appropriate rendezvous
52 * address and the caller and callee client programs establish a
53 * stream connection through which the conversation takes place.
54 */
55
56struct osockaddr {
57 unsigned short sa_family; /* address family */
58 char sa_data[14]; /* up to 14 bytes of direct address */
59};
60
61/*
62 * Client->server request message format.
63 */
64typedef struct {
65 unsigned char vers; /* protocol version */
66 unsigned char type; /* request type, see below */
67 unsigned char answer; /* not used */
68 unsigned char pad;
69 u_int32_t id_num; /* message id */
70 struct osockaddr addr; /* old (4.3) style */
71 struct osockaddr ctl_addr; /* old (4.3) style */
72 int32_t pid; /* caller's process id */
73#define NAME_SIZE 12
74 char l_name[NAME_SIZE]; /* caller's name */
75 char r_name[NAME_SIZE]; /* callee's name */
76#define TTY_SIZE 16
77 char r_tty[TTY_SIZE]; /* callee's tty name */
78} CTL_MSG;
79
80/*
81 * Server->client response message format.
82 */
83typedef struct {
84 unsigned char vers; /* protocol version */
85 unsigned char type; /* type of request message, see below */
86 unsigned char answer; /* response to request message,
87 see below */
88 unsigned char pad;
89 u_int32_t id_num; /* message id */
90 struct osockaddr addr; /* address for establishing
91 conversation */
92} CTL_RESPONSE;
93
94#define TALK_VERSION 1 /* protocol version */
95
96/* message type values */
97#define LEAVE_INVITE 0 /* leave invitation with server */
98#define LOOK_UP 1 /* check for invitation by callee */
99#define DELETE 2 /* delete invitation by caller */
100#define ANNOUNCE 3 /* announce invitation by caller */
101
102/* answer values */
103#define SUCCESS 0 /* operation completed properly */
104#define NOT_HERE 1 /* callee not logged in */
105#define FAILED 2 /* operation failed for unexplained reason */
106#define MACHINE_UNKNOWN 3 /* caller's machine name unknown */
107#define PERMISSION_DENIED 4 /* callee's tty doesn't permit announce */
108#define UNKNOWN_REQUEST 5 /* request has invalid type value */
109#define BADVERSION 6 /* request has invalid protocol version */
110#define BADADDR 7 /* request has invalid addr value */
111#define BADCTLADDR 8 /* request has invalid ctl_addr value */
112
113/*
114 * Operational parameters.
115 */
116#define MAX_LIFE 60 /* max time daemon saves invitations */
117/* RING_WAIT should be 10's of seconds less than MAX_LIFE */
118#define RING_WAIT 30 /* time to wait before resending invitation */
119
120#endif /* !_TALKD_H_ */