xref: /freebsd/usr.sbin/bluetooth/hcsecd/hcsecd.conf.5 (revision 0986ab12e44caea472245845f9a89ced4f137d73)
1.\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin@yahoo.com>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $Id: hcsecd.conf.5,v 1.1 2003/05/26 22:49:23 max Exp $
26.\" $FreeBSD$
27.\"
28.Dd May 26, 2003
29.Dt HCSECD.CONF 5
30.Os
31.Sh NAME
32.Nm hcsecd.conf
33.Nd
34.Xr hcsecd 8
35configuration file
36.Sh DESCRIPTION
37The
38.Nm
39file is the configuration file for the
40.Xr hcsecd 8
41Bluetooth link keys/PIN codes management daemon.
42.Pp
43The
44.Nm
45file is a free-form ASCII text file.
46It is parsed by the recursive-descent parser built into
47.Xr hcsecd 8 .
48The file may contain extra tabs and newlines for formatting purposes.
49Keywords in the file are case-sensitive.
50Comments may be placed anywhere within the file (except within quotes).
51Comments begin with the
52.Dq #
53character and end at the end of the line.
54.Sh FILE FORMAT
55The
56.Nm
57file consists of a list of
58.Cm device
59entries.
60Each
61.Cm device
62entry defines a link key or PIN code for a remote Bluetooth device.
63Each remote Bluetooth device is identified by its unique BD_ADDR.
64.Pp
65The
66.Cm device
67entry
68.Pp
69.Cm device
70{
71.Cm option Ar argument ;
72.Oo
73.Cm option Ar argument ;
74.Oc
75}
76.Pp
77The following section describes all supported options and arguments
78.Bl -tag -width indent
79.It Cm bdaddr Ar BD_ADDR
80Specify remote device BD_ADDR for the entry.
81.It Cm name Ar device_name
82Specify user friendly name for the entry.
83Name is a string in a straight double quotes.
84.It Cm key Ar link_key
85Specify link key for the entry.
86Link key is hexadecimal string upto 32 characters in length starting with
87.Dq 0x .
88.It Cm key nokey
89Specify no link key for the entry.
90.It Cm pin Ar PIN_code
91Specify PIN code for the entry.
92PIN code is a string upto 16 characters in length in a straight double quotes.
93.It Cm pin nopin
94Specify no PIN code for the entry.
95.El
96.Sh EXAMPLES
97A sample
98.Nm
99file
100.Bd -literal
101# Default entry is applied if no better match found
102# It MUST have 00:00:00:00:00:00 as bdaddr
103device {
104        bdaddr  00:00:00:00:00:00;
105        name    "Default entry";
106        key     nokey;
107        pin     nopin;
108}
109
110# Ericsson T68 phone
111device {
112        bdaddr  00:80:37:5e:4d:d4;
113        name    "Ericsson T68 phone";
114        key     nokey;
115        pin     "0000"; # PIN code
116}
117
118# Dummy device
119device {
120        bdaddr  00:11:22:33:44:55;
121        name    "Dummy";
122        key     0x00112233445566778899aabbccddeeff; # 16 bytes key
123        pin     nopin;
124}
125.Ed
126.Sh SEE ALSO
127.Xr hcsecd 8
128.Sh AUTHORS
129.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
130