usr.sbin/bthcid/bthcid.conf.5

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