Commit a56cda3f authored by Olivier Crête's avatar Olivier Crête 👻

import

darcs-hash:20060926215024-b59df-787a30444c3ae416c309322e1bdd26fd438fdc10.gz
parents
Dafydd Harries <dafydd.harries@collabora.co.uk>
This diff is collapsed.
Installation Instructions
*************************
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
Software Foundation, Inc.
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
Basic Installation
==================
These are generic installation instructions.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').
It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. (Caching is
disabled by default to prevent problems with accidental use of stale
cache files.)
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `configure.ac' (or `configure.in') is used to create
`configure' by a program called `autoconf'. You only need
`configure.ac' if you want to change it or regenerate `configure' using
a newer version of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system. If you're
using `csh' on an old version of System V, you might need to type
`sh ./configure' instead to prevent `csh' from trying to execute
`configure' itself.
Running `configure' takes awhile. While running, it prints some
messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that the
`configure' script does not know about. Run `./configure --help' for
details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
is an example:
./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
If you have to use a `make' that does not support the `VPATH'
variable, you have to compile the package for one architecture at a
time in the source code directory. After you have installed the
package for one architecture, use `make distclean' before reconfiguring
for another architecture.
Installation Names
==================
By default, `make install' installs the package's commands under
`/usr/local/bin', include files under `/usr/local/include', etc. You
can specify an installation prefix other than `/usr/local' by giving
`configure' the option `--prefix=PREFIX'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
PREFIX as the prefix for installing programs and libraries.
Documentation and other data files still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=DIR' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
=================
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
==========================
There may be some features `configure' cannot figure out automatically,
but needs to determine by the type of machine the package will run on.
Usually, assuming the package is built to be run on the _same_
architectures, `configure' can figure that out, but if it prints a
message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
CPU-COMPANY-SYSTEM
where SYSTEM can have one of these forms:
OS KERNEL-OS
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the option `--target=TYPE' to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share, you
can create a site shell script called `config.site' that gives default
values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
==================
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
causes the specified `gcc' to be used as the C compiler (unless it is
overridden in the site shell script). Here is a another example:
/bin/bash ./configure CONFIG_SHELL=/bin/bash
Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
configuration-related scripts to be executed by `/bin/bash'.
`configure' Invocation
======================
`configure' recognizes the following options to control how it operates.
`--help'
`-h'
Print a summary of the options to `configure', and exit.
`--version'
`-V'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`--cache-file=FILE'
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
`--config-cache'
`-C'
Alias for `--cache-file=config.cache'.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.
SUBDIRS = tests
# Boring file regexps:
\.hi$
\.o$
\.o\.cmd$
# *.ko files aren't boring by default because they might
# be Korean translations rather than kernel modules.
# \.ko$
\.ko\.cmd$
\.mod\.c$
(^|/)\.tmp_versions($|/)
(^|/)CVS($|/)
(^|/)RCS($|/)
~$
#(^|/)\.[^/]
(^|/)_darcs($|/)
\.bak$
\.BAK$
\.orig$
(^|/)vssver\.scc$
\.swn$
\.swo$
\.swp$
(^|/)MT($|/)
(^|/)\{arch\}($|/)
(^|/).arch-ids($|/)
(^|/),
\.class$
\.prof$
(^|/)\.DS_Store$
(^|/)BitKeeper($|/)
(^|/)ChangeSet($|/)
(^|/)\.svn($|/)
\.py[co]$
\#
\.cvsignore$
(^|/)Thumbs\.db$
(^|/)autom4te\.cache($|/)
^missing
^install-sh$
^configure$
^depcomp$
^aclocal.m4$
^compile$
^\.deps$
(^|.*/)Makefile.in
/* config.h.in. Generated from configure.ac by autoheader. */
/* Name of package */
#undef PACKAGE
/* Define to the address where bug reports for this package should be sent. */
#undef PACKAGE_BUGREPORT
/* Define to the full name of this package. */
#undef PACKAGE_NAME
/* Define to the full name and version of this package. */
#undef PACKAGE_STRING
/* Define to the one symbol short name of this package. */
#undef PACKAGE_TARNAME
/* Define to the version of this package. */
#undef PACKAGE_VERSION
/* Version number of package */
#undef VERSION
AC_PREREQ(2.60)
AC_INIT(stun, 0.0.1)
AC_CONFIG_SRCDIR([.])
AC_CONFIG_HEADER([config.h])
AM_INIT_AUTOMAKE
AC_CONFIG_FILES([Makefile tests/Makefile])
# Checks for programs.
AC_PROG_CC
# Checks for libraries.
AM_PATH_CHECK()
PKG_CHECK_MODULES(GLIB, [glib-2.0 >= 2.4, gobject-2.0 >= 2.4])
AC_OUTPUT
#include "stun.h"
#include <arpa/inet.h>
#include <string.h>
/* remove */
#include <stdio.h>
static StunAttribute *
stun_attribute_new(guint type)
{
StunAttribute *attr = g_slice_alloc(sizeof(StunAttribute));
attr->type = type;
return attr;
}
StunAttribute *
stun_attribute_mapped_address_new(guint32 ip, guint16 port)
{
StunAttribute *attr = stun_attribute_new(STUN_ATTRIBUTE_MAPPED_ADDRESS);
attr->length = 8;
attr->address.padding = 0;
attr->address.af = 1;
attr->address.ip = ip;
attr->address.port = port;
return attr;
}
void
stun_attribute_free(StunAttribute *attr)
{
g_slice_free1(sizeof(StunAttribute), attr);
}
StunAttribute *
stun_attribute_unpack(guint length, const gchar *s)
{
StunAttribute *attr;
g_assert(length);
attr = stun_attribute_new(ntohs(*(guint16 *)s));
switch (attr->type) {
case STUN_ATTRIBUTE_MAPPED_ADDRESS:
attr->address.af = (guint8)s[5];
g_assert(attr->address.af == 1);
attr->address.port = ntohs(*(guint16 *)(s + 6));
attr->address.ip = ntohl(*(guint32 *)(s + 8));
break;
default:
g_assert_not_reached();
stun_attribute_free(attr);
return NULL;
}
return attr;
}
guint
stun_attribute_pack(StunAttribute *attr, gchar **packed)
{
switch (attr->type) {
case STUN_ATTRIBUTE_MAPPED_ADDRESS:
{
StunAttribute *ret = g_malloc0(sizeof(StunAttribute));
ret->type = htons(attr->type);
ret->length = htons(8);
ret->address.af = attr->address.af;
ret->address.port = htons(attr->address.port);
ret->address.ip = htonl(attr->address.ip);
*packed = (gchar *)ret;
return 12;
}
default:
return 0;
}
}
gchar *
stun_attribute_dump(StunAttribute *attr)
{
switch (attr->type) {
case STUN_ATTRIBUTE_MAPPED_ADDRESS:
return g_strdup_printf(
"MAPPED-ADDRESS %d.%d.%d.%d:%d",
(attr->address.ip & 0xff000000) >> 24,
(attr->address.ip & 0x00ff0000) >> 16,
(attr->address.ip & 0x0000ff00) >> 8,
(attr->address.ip & 0x000000ff) >> 0,
attr->address.port);
default:
return NULL;
}
}
static StunMessage *
stun_message_new(guint type)
{
StunMessage *msg = g_slice_alloc0(sizeof(StunMessage));
msg->type = type;
return msg;
}
StunMessage *
stun_message_binding_request_new()
{
return stun_message_new(STUN_MESSAGE_BINDING_REQUEST);
}
void
stun_message_free(StunMessage *msg)
{
StunAttribute **attr;
if (msg->attributes) {
for (attr = msg->attributes; *attr; attr++)
stun_attribute_free(*attr);
g_free(msg->attributes);
}
g_slice_free1(sizeof(StunMessage), msg);
}
StunMessage *
stun_message_unpack(guint length, gchar *s)
{
gchar *t;
guint attr_length;
guint n_attributes = 0;
guint i;
StunAttribute *attr;
StunMessage *msg = stun_message_new(STUN_MESSAGE_BINDING_REQUEST);
/* message header is 20 bytes */
g_assert(length >= 20);
/* unpack the header */
msg->type = ntohs(*(guint16 *)(s + 0));
memcpy(msg->transaction_id, s + 4, 16);
/* count the number of attributes */
for (t = s + 20; t - s < length; t += attr_length + 4) {
attr_length = ntohs(*(guint16 *)(t + 2));
n_attributes++;
}
/* allocate memory for the attribute list and terminate it */
msg->attributes = g_malloc0((n_attributes + 1) * sizeof(StunAttribute *));
msg->attributes[n_attributes] = NULL;
/* unpack attributes */
for (i = 0, t = s + 20; i < n_attributes; i++, t += attr_length + 4) {
attr_length = ntohs(*(guint16 *)(t + 2));
attr = msg->attributes[i] = stun_attribute_unpack(attr_length, t);
}
return msg;
}
guint
stun_message_pack(StunMessage *msg, gchar **packed)
{
GString *tmp = g_string_new("");
unsigned int packed_type;
guint16 packed_length;
guint length = 20;
if (msg->attributes) {
StunAttribute **attr;
for (attr = msg->attributes; *attr; attr++)
length += 4 + (*attr)->length;
}
packed_type = htons(msg->type);
packed_length = htons(length);
g_string_append_printf(tmp, "%c%c%c%c",
((gchar *)&packed_type)[0],
((gchar *)&packed_type)[1],
((gchar *)&packed_length)[0],
((gchar *)&packed_length)[1]);
g_string_append_len(tmp, msg->transaction_id, 16);
if (msg->attributes) {
StunAttribute **attr;
for (attr = msg->attributes; *attr; attr++) {
gchar *attr_packed;
guint attr_length = stun_attribute_pack(*attr, &attr_packed);
g_string_append_len(tmp, attr_packed, attr_length);
g_free(attr_packed);
}
}
*packed = g_string_free(tmp, FALSE);
return length;
}
gchar *
stun_message_dump (StunMessage *msg)
{
StunAttribute **attr;
GString *tmp = g_string_new("");
const gchar *name;
switch (msg->type) {
case STUN_MESSAGE_BINDING_REQUEST:
name = "BINDING-REQUEST";
break;
default:
return NULL;
}
g_string_printf(tmp,
"%s %08x:%08x:%08x:%08x",
name,
*(guint32*)(msg->transaction_id),
*(guint32*)(msg->transaction_id + 4),
*(guint32*)(msg->transaction_id + 8),
*(guint32*)(msg->transaction_id + 12));
if (msg->attributes) {
for (attr = msg->attributes; *attr; attr++) {
gchar *dump = stun_attribute_dump(*attr);
g_string_append_printf(tmp, "\n %s", dump);
g_free(dump);
}
}
return g_string_free(tmp, FALSE);
}
#ifndef __STUN_H__
#define __STUN_H__
#include <glib.h>
typedef enum {
STUN_MESSAGE_BINDING_REQUEST = 0x001,
STUN_MESSAGE_BINDING_RESPONSE = 0x101,
STUN_MESSAGE_BINDING_ERROR_RESPONSE = 0x111,
STUN_MESSAGE_SHARED_SECRET_REQUEST = 0x002,
STUN_MESSAGE_SHARED_SECRET_RESPONSE = 0x102,
STUN_MESSAGE_SHARED_SECRET_ERROR_RESPONSE = 0x112
} StunMessageType;
typedef enum {
STUN_ATTRIBUTE_MAPPED_ADDRESS = 0x1,
STUN_ATTRIBUTE_RESPONSE_ADDRESS = 0x2,
STUN_ATTRIBUTE_CHANGE_REQUEST = 0x3,
STUN_ATTRIBUTE_CHANGED_ADDRESS = 0x4,
STUN_ATTRIBUTE_SOURCE_ADDRESS = 0x5,
STUN_ATTRIBUTE_USERNAME = 0x6,
STUN_ATTRIBUTE_PASSWORD = 0x7,
STUN_ATTRIBUTE_MESSAGE_INTEGRITY = 0x8,
STUN_ATTRIBUTE_ERROR_CODE = 0x9,
STUN_ATTRIBUTE_UNKNOWN_ATTRIBUTES = 0xa,
STUN_ATTRIBUTE_REFLECTED_FROM = 0xb
} StunAttributeType;
typedef struct _StunAttributeAddress StunAttributeAddress;
struct _StunAttributeAddress {
guint8 padding;
guint8 af;
guint16 port;
guint32 ip;
};
typedef struct _StunAttribute StunAttribute;
struct _StunAttribute {
guint16 type;
guint16 length;
StunAttributeAddress address;
};
typedef struct _StunMessage StunMessage;
struct _StunMessage {
guint16 type;
gchar transaction_id[16];
StunAttribute **attributes;
};
StunAttribute *
stun_attribute_mapped_address_new(guint32 ip_address, guint16 port);
void
stun_attribute_free(StunAttribute *attr);
guint
stun_attribute_pack(StunAttribute *attr, gchar **ret);
gchar *
stun_attribute_dump(StunAttribute *attr);
StunAttribute *
stun_attribute_unpack(guint length, const gchar *s);
StunMessage *
stun_message_binding_request_new();
void
stun_message_free(StunMessage *msg);
guint
stun_message_pack(StunMessage *msg, gchar **packed);
gchar *
stun_message_dump (StunMessage *msg);
StunMessage *
stun_message_unpack(guint length, gchar *s);
#endif /* __STUN_H__ */
AM_CFLAGS = -std=c99 -Wall -Werror
test_SOURCES = test.c $(top_srcdir)/stun/stun.h $(top_srcdir)/stun/stun.c
test_CFLAGS = -I$(top_srcdir)/stun $(AM_CFLAGS) @CHECK_CFLAGS@ @GLIB_CFLAGS@
test_LDADD = @CHECK_LIBS@ @GLIB_LIBS@
TESTS = test
noinst_PROGRAMS = test
#include <string.h>
#include <check.h>
#include <stun.h>
START_TEST (test_attribute_pack)
{
StunAttribute *attr = stun_attribute_mapped_address_new(0x02030405, 2345);
gchar *packed;
guint length;
length = stun_attribute_pack(attr, &packed);
fail_unless(12 == length);
fail_unless(NULL != packed);
fail_unless(0 == memcmp(packed,
"\x00\x01" // type
"\x00\x08" // length
"\x00\x01" // padding, address family
"\x09\x29" // port
"\x02\x03\x04\x05", // IP address
length));
g_free(packed);
stun_attribute_free(attr);
}
END_TEST
START_TEST (test_attribute_dump)
{
StunAttribute *attr = stun_attribute_mapped_address_new(0x02030405, 2345);
gchar *dump = stun_attribute_dump(attr);
fail_unless(NULL != dump);
fail_unless(0 == strcmp(dump, "MAPPED-ADDRESS 2.3.4.5:2345"));
g_free(dump);
stun_attribute_free(attr);
}
END_TEST
START_TEST (test_attribute_unpack)
{
StunAttribute *attr = stun_attribute_unpack(12,
"\x00\x01" // type
"\x00\x08" // length
"\x00\x01" // padding, address family
"\x09\x29" // port
"\x02\x03\x04\x05" // IP address
);
fail_unless(NULL != attr);
fail_unless(attr->type == STUN_ATTRIBUTE_MAPPED_ADDRESS);
fail_unless(attr->address.af == 1);
fail_unless(attr->address.port == 2345);
fail_unless(attr->address.ip == 0x02030405);
stun_attribute_free(attr);
}
END_TEST
START_TEST (test_message_pack)
{
StunMessage *msg = stun_message_binding_request_new();
gchar *packed;
guint length;
memcpy(msg->transaction_id,
"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f", 16);
msg->attributes = g_malloc0(2 * sizeof(StunAttribute *));
msg->attributes[0] = stun_attribute_mapped_address_new(0x02030405, 2345);
length = stun_message_pack(msg, &packed);
fail_unless(packed != NULL);
fail_unless(length == 32);
fail_unless(0 == memcmp(packed + 0, "\x00\x01", 2));
fail_unless(0 == memcmp(packed + 2, "\x00\x20", 2));
fail_unless(0 == memcmp(packed + 4,
"\x00\x01\x02\x03"