xref: /freebsd/usr.sbin/bluetooth/hcsecd/hcsecd.conf.5 (revision b2c76c41be32f904179efed29c0ca04d53f3996c)
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.\"
27.Dd May 26, 2003
28.Dt HCSECD.CONF 5
29.Os
30.Sh NAME
31.Nm hcsecd.conf
32.Nd
33.Xr hcsecd 8
34configuration file
35.Sh DESCRIPTION
36The
37.Nm
38file is the configuration file for the
39.Xr hcsecd 8
40Bluetooth link keys/PIN codes management daemon.
41.Pp
42The
43.Nm
44file is a free-form
45.Tn ASCII
46text file.
47It is parsed by the recursive-descent parser built into
48.Xr hcsecd 8 .
49The file may contain extra tabs and newlines for formatting purposes.
50Keywords in the file are case-sensitive.
51Comments may be placed anywhere within the file (except within quotes).
52Comments begin with the
53.Ql #
54character and end at the end of the line.
55.Sh FILE FORMAT
56The
57.Nm
58file consists of a list of
59.Cm device
60entries.
61Each
62.Cm device
63entry defines a link key or PIN code for a remote Bluetooth device.
64Each remote Bluetooth device is identified by its unique BD_ADDR.
65.Pp
66The
67.Cm device
68entry
69.Pp
70.Cm device
71{
72.Cm option Ar argument ;
73.Oo
74.Cm option Ar argument ;
75.Oc
76}
77.Pp
78The following section describes all supported options and arguments.
79.Bl -tag -width indent
80.It Cm bdaddr Ar BD_ADDR
81Specify remote device BD_ADDR for the entry.
82.It Cm name Ar device_name
83Specify user friendly name for the entry.
84Name is a string in straight double quotes.
85.It Cm key Ar link_key
86Specify link key for the entry.
87Link key is hexadecimal string up to 32 characters in length starting with
88.Ql 0x .
89.It Cm key nokey
90Specify no link key for the entry.
91.It Cm pin Ar PIN_code
92Specify PIN code for the entry.
93PIN code is a string up to 16 characters in length in straight double quotes.
94.It Cm pin nopin
95Specify no PIN code for the entry.
96.El
97.Sh EXAMPLES
98A sample
99.Nm
100file:
101.Bd -literal
102# Default entry is applied if no better match found
103# It MUST have 00:00:00:00:00:00 as bdaddr
104device {
105        bdaddr  00:00:00:00:00:00;
106        name    "Default entry";
107        key     nokey;
108        pin     nopin;
109}
110
111# Ericsson T68 phone
112device {
113        bdaddr  00:80:37:5e:4d:d4;
114        name    "Ericsson T68 phone";
115        key     nokey;
116        pin     "0000"; # PIN code
117}
118
119# Dummy device
120device {
121        bdaddr  00:11:22:33:44:55;
122        name    "Dummy";
123        key     0x00112233445566778899aabbccddeeff; # 16 bytes key
124        pin     nopin;
125}
126.Ed
127.Sh SEE ALSO
128.Xr hcsecd 8
129.Sh AUTHORS
130.An Maksim Yevmenkin Aq Mt m_evmenkin@yahoo.com
131