4 ### Service for establishing dynamic connections
6 ### (c) 2006 Straylight/Edgeware
9 ###----- Licensing notice ---------------------------------------------------
11 ### This file is part of Trivial IP Encryption (TrIPE).
13 ### TrIPE is free software; you can redistribute it and/or modify
14 ### it under the terms of the GNU General Public License as published by
15 ### the Free Software Foundation; either version 2 of the License, or
16 ### (at your option) any later version.
18 ### TrIPE is distributed in the hope that it will be useful,
19 ### but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ### GNU General Public License for more details.
23 ### You should have received a copy of the GNU General Public License
24 ### along with TrIPE; if not, write to the Free Software Foundation,
25 ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 ###--------------------------------------------------------------------------
30 ### External dependencies.
32 from optparse import OptionParser
41 ###--------------------------------------------------------------------------
42 ### Main service machinery.
44 _magic = ['_magic'] # An object distinct from all others
47 """Representation of a peer in the database."""
49 def __init__(me, peer, cdb = None):
51 Create a new peer, named PEER.
53 Information about the peer is read from the database CDB, or the default
54 one given on the command-line.
58 record = (cdb or CDB.init(opts.cdb))['P' + peer]
60 raise T.TripeJobError('unknown-peer', peer)
61 me.__dict__.update(M.URLDecode(record, semip = True))
63 def get(me, key, default = _magic):
65 Get the information stashed under KEY from the peer's database record.
67 If DEFAULT is given, then use it if the database doesn't contain the
68 necessary information. If no DEFAULT is given, then report an error.
70 attr = me.__dict__.get(key, default)
72 raise T.TripeJobError('malformed-peer', me.name, 'missing-key', key)
77 Iterate over the available keys in the peer's database record.
79 return me.__dict__.iterkeys()
81 def addpeer(peer, addr):
83 Process a connect request from a new peer PEER on address ADDR.
85 Any existing peer with this name is disconnected from the server.
87 if peer.name in S.list():
91 tunnel = peer.get('tunnel', None),
92 keepalive = peer.get('keepalive', None),
93 key = peer.get('key', None),
94 cork = peer.get('cork', 'nil') in ['t', 'true', 'y', 'yes', 'on'],
96 except T.TripeError, exc:
97 raise T.TripeJobError(*exc.args)
101 active NAME: Handle an active connection request for the peer called NAME.
103 The appropriate address is read from the database automatically.
106 addr = peer.get('peer')
107 if addr == 'PASSIVE':
108 raise T.TripeJobError('passive-peer', name)
109 addpeer(peer, M.split(addr, quotep = True)[0])
113 list: Report a list of the available active peers.
115 cdb = CDB.init(opts.cdb)
116 for key in cdb.keys():
117 if key.startswith('P') and Peer(key[1:]).get('peer', '') != 'PASSIVE':
122 info NAME: Report the database entries for the named peer.
125 items = list(peer.list())
128 T.svcinfo('%s=%s' % (i, peer.get(i)))
130 ## Dictionary mapping challenges to waiting passive-connection coroutines.
133 def cmd_passive(*args):
135 passive [OPTIONS] USER: Await the arrival of the named USER.
137 Report a challenge; when (and if!) the server receives a greeting quoting
138 this challenge, add the corresponding peer to the server.
141 op = T.OptParse(args, ['-timeout'])
143 if opt == '-timeout':
144 timeout = T.timespec(op.arg())
145 user, = op.rest(1, 1)
147 peer = CDB.init(opts.cdb)['U' + user]
149 raise T.TripeJobError('unknown-user', user)
151 cr = T.Coroutine.getcurrent()
152 timer = M.SelTimer(time() + timeout, lambda: cr.switch(None))
156 addr = cr.parent.switch()
158 raise T.TripeJobError('connect-timeout')
159 addpeer(Peer(peer), addr)
163 def notify(_, code, *rest):
165 Watch for notifications.
167 In particular, if a GREETing appears quoting a challenge in the chalmap
168 then wake up the corresponding coroutine.
175 chalmap[chal].switch(addr)
177 ###--------------------------------------------------------------------------
184 Register the notification-watcher, and add the automatic active peers.
186 S.handler['NOTE'] = notify
189 cdb = CDB.init(opts.cdb)
194 for name in M.split(autos)[0]:
196 peer = Peer(name, cdb)
197 addpeer(peer, M.split(peer.get('peer'), quotep = True)[0])
198 except T.TripeJobError, err:
199 S.warn('connect', 'auto-add-failed', name, *err.args)
203 Parse the command-line options.
205 Automatically changes directory to the requested configdir, and turns on
206 debugging. Returns the options object.
208 op = OptionParser(usage = '%prog [-a FILE] [-d DIR]',
209 version = '%%prog %s' % VERSION)
211 op.add_option('-a', '--admin-socket',
212 metavar = 'FILE', dest = 'tripesock', default = T.tripesock,
213 help = 'Select socket to connect to [default %default]')
214 op.add_option('-d', '--directory',
215 metavar = 'DIR', dest = 'dir', default = T.configdir,
216 help = 'Select current diretory [default %default]')
217 op.add_option('-p', '--peerdb',
218 metavar = 'FILE', dest = 'cdb', default = T.peerdb,
219 help = 'Select peers database [default %default]')
220 op.add_option('--daemon', dest = 'daemon',
221 default = False, action = 'store_true',
222 help = 'Become a daemon after successful initialization')
223 op.add_option('--debug', dest = 'debug',
224 default = False, action = 'store_true',
225 help = 'Emit debugging trace information')
226 op.add_option('--startup', dest = 'startup',
227 default = False, action = 'store_true',
228 help = 'Being called as part of the server startup')
230 opts, args = op.parse_args()
231 if args: op.error('no arguments permitted')
233 T._debug = opts.debug
236 ## Service table, for running manually.
237 service_info = [('connect', VERSION, {
238 'passive': (1, None, '[OPTIONS] USER', cmd_passive),
239 'active': (1, 1, 'PEER', cmd_active),
240 'info': (1, 1, 'PEER', cmd_info),
241 'list': (0, 0, '', cmd_list)
244 if __name__ == '__main__':
245 opts = parse_options()
246 T.runservices(opts.tripesock, service_info,
248 daemon = opts.daemon)
250 ###----- That's all, folks --------------------------------------------------