Revision 0:b88aaf284554

b/.hgignore
1 1
syntax: glob
2 2
*.pyc
3
*.swp
4
*.orig
5
*.bak
/dev/null
1

  
2
		    GNU GENERAL PUBLIC LICENSE
3
		       Version 3, 29 June 2007
4

  
5
 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
6
 Everyone is permitted to copy and distribute verbatim copies
7
 of this license document, but changing it is not allowed.
8

  
9
			    Preamble
10

  
11
  The GNU General Public License is a free, copyleft license for
12
software and other kinds of works.
13

  
14
  The licenses for most software and other practical works are designed
15
to take away your freedom to share and change the works.  By contrast,
16
the GNU General Public License is intended to guarantee your freedom to
17
share and change all versions of a program--to make sure it remains free
18
software for all its users.  We, the Free Software Foundation, use the
19
GNU General Public License for most of our software; it applies also to
20
any other work released this way by its authors.  You can apply it to
21
your programs, too.
22

  
23
  When we speak of free software, we are referring to freedom, not
24
price.  Our General Public Licenses are designed to make sure that you
25
have the freedom to distribute copies of free software (and charge for
26
them if you wish), that you receive source code or can get it if you
27
want it, that you can change the software or use pieces of it in new
28
free programs, and that you know you can do these things.
29

  
30
  To protect your rights, we need to prevent others from denying you
31
these rights or asking you to surrender the rights.  Therefore, you have
32
certain responsibilities if you distribute copies of the software, or if
33
you modify it: responsibilities to respect the freedom of others.
34

  
35
  For example, if you distribute copies of such a program, whether
36
gratis or for a fee, you must pass on to the recipients the same
37
freedoms that you received.  You must make sure that they, too, receive
38
or can get the source code.  And you must show them these terms so they
39
know their rights.
40

  
41
  Developers that use the GNU GPL protect your rights with two steps:
42
(1) assert copyright on the software, and (2) offer you this License
43
giving you legal permission to copy, distribute and/or modify it.
44

  
45
  For the developers' and authors' protection, the GPL clearly explains
46
that there is no warranty for this free software.  For both users' and
47
authors' sake, the GPL requires that modified versions be marked as
48
changed, so that their problems will not be attributed erroneously to
49
authors of previous versions.
50

  
51
  Some devices are designed to deny users access to install or run
52
modified versions of the software inside them, although the manufacturer
53
can do so.  This is fundamentally incompatible with the aim of
54
protecting users' freedom to change the software.  The systematic
55
pattern of such abuse occurs in the area of products for individuals to
56
use, which is precisely where it is most unacceptable.  Therefore, we
57
have designed this version of the GPL to prohibit the practice for those
58
products.  If such problems arise substantially in other domains, we
59
stand ready to extend this provision to those domains in future versions
60
of the GPL, as needed to protect the freedom of users.
61

  
62
  Finally, every program is threatened constantly by software patents.
63
States should not allow patents to restrict development and use of
64
software on general-purpose computers, but in those that do, we wish to
65
avoid the special danger that patents applied to a free program could
66
make it effectively proprietary.  To prevent this, the GPL assures that
67
patents cannot be used to render the program non-free.
68

  
69
  The precise terms and conditions for copying, distribution and
70
modification follow.
71

  
72
		       TERMS AND CONDITIONS
73

  
74
  0. Definitions.
75

  
76
  "This License" refers to version 3 of the GNU General Public License.
77

  
78
  "Copyright" also means copyright-like laws that apply to other kinds of
79
works, such as semiconductor masks.
80
 
81
  "The Program" refers to any copyrightable work licensed under this
82
License.  Each licensee is addressed as "you".  "Licensees" and
83
"recipients" may be individuals or organizations.
84

  
85
  To "modify" a work means to copy from or adapt all or part of the work
86
in a fashion requiring copyright permission, other than the making of an
87
exact copy.  The resulting work is called a "modified version" of the
88
earlier work or a work "based on" the earlier work.
89

  
90
  A "covered work" means either the unmodified Program or a work based
91
on the Program.
92

  
93
  To "propagate" a work means to do anything with it that, without
94
permission, would make you directly or secondarily liable for
95
infringement under applicable copyright law, except executing it on a
96
computer or modifying a private copy.  Propagation includes copying,
97
distribution (with or without modification), making available to the
98
public, and in some countries other activities as well.
99

  
100
  To "convey" a work means any kind of propagation that enables other
101
parties to make or receive copies.  Mere interaction with a user through
102
a computer network, with no transfer of a copy, is not conveying.
103

  
104
  An interactive user interface displays "Appropriate Legal Notices"
105
to the extent that it includes a convenient and prominently visible
106
feature that (1) displays an appropriate copyright notice, and (2)
107
tells the user that there is no warranty for the work (except to the
108
extent that warranties are provided), that licensees may convey the
109
work under this License, and how to view a copy of this License.  If
110
the interface presents a list of user commands or options, such as a
111
menu, a prominent item in the list meets this criterion.
112

  
113
  1. Source Code.
114

  
115
  The "source code" for a work means the preferred form of the work
116
for making modifications to it.  "Object code" means any non-source
117
form of a work.
118

  
119
  A "Standard Interface" means an interface that either is an official
120
standard defined by a recognized standards body, or, in the case of
121
interfaces specified for a particular programming language, one that
122
is widely used among developers working in that language.
123

  
124
  The "System Libraries" of an executable work include anything, other
125
than the work as a whole, that (a) is included in the normal form of
126
packaging a Major Component, but which is not part of that Major
127
Component, and (b) serves only to enable use of the work with that
128
Major Component, or to implement a Standard Interface for which an
129
implementation is available to the public in source code form.  A
130
"Major Component", in this context, means a major essential component
131
(kernel, window system, and so on) of the specific operating system
132
(if any) on which the executable work runs, or a compiler used to
133
produce the work, or an object code interpreter used to run it.
134

  
135
  The "Corresponding Source" for a work in object code form means all
136
the source code needed to generate, install, and (for an executable
137
work) run the object code and to modify the work, including scripts to
138
control those activities.  However, it does not include the work's
139
System Libraries, or general-purpose tools or generally available free
140
programs which are used unmodified in performing those activities but
141
which are not part of the work.  For example, Corresponding Source
142
includes interface definition files associated with source files for
143
the work, and the source code for shared libraries and dynamically
144
linked subprograms that the work is specifically designed to require,
145
such as by intimate data communication or control flow between those
146
subprograms and other parts of the work.
147

  
148
  The Corresponding Source need not include anything that users
149
can regenerate automatically from other parts of the Corresponding
150
Source.
151

  
152
  The Corresponding Source for a work in source code form is that
153
same work.
154

  
155
  2. Basic Permissions.
156

  
157
  All rights granted under this License are granted for the term of
158
copyright on the Program, and are irrevocable provided the stated
159
conditions are met.  This License explicitly affirms your unlimited
160
permission to run the unmodified Program.  The output from running a
161
covered work is covered by this License only if the output, given its
162
content, constitutes a covered work.  This License acknowledges your
163
rights of fair use or other equivalent, as provided by copyright law.
164

  
165
  You may make, run and propagate covered works that you do not
166
convey, without conditions so long as your license otherwise remains
167
in force.  You may convey covered works to others for the sole purpose
168
of having them make modifications exclusively for you, or provide you
169
with facilities for running those works, provided that you comply with
170
the terms of this License in conveying all material for which you do
171
not control copyright.  Those thus making or running the covered works
172
for you must do so exclusively on your behalf, under your direction
173
and control, on terms that prohibit them from making any copies of
174
your copyrighted material outside their relationship with you.
175

  
176
  Conveying under any other circumstances is permitted solely under
177
the conditions stated below.  Sublicensing is not allowed; section 10
178
makes it unnecessary.
179

  
180
  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
181

  
182
  No covered work shall be deemed part of an effective technological
183
measure under any applicable law fulfilling obligations under article
184
11 of the WIPO copyright treaty adopted on 20 December 1996, or
185
similar laws prohibiting or restricting circumvention of such
186
measures.
187

  
188
  When you convey a covered work, you waive any legal power to forbid
189
circumvention of technological measures to the extent such circumvention
190
is effected by exercising rights under this License with respect to
191
the covered work, and you disclaim any intention to limit operation or
192
modification of the work as a means of enforcing, against the work's
193
users, your or third parties' legal rights to forbid circumvention of
194
technological measures.
195

  
196
  4. Conveying Verbatim Copies.
197

  
198
  You may convey verbatim copies of the Program's source code as you
199
receive it, in any medium, provided that you conspicuously and
200
appropriately publish on each copy an appropriate copyright notice;
201
keep intact all notices stating that this License and any
202
non-permissive terms added in accord with section 7 apply to the code;
203
keep intact all notices of the absence of any warranty; and give all
204
recipients a copy of this License along with the Program.
205

  
206
  You may charge any price or no price for each copy that you convey,
207
and you may offer support or warranty protection for a fee.
208

  
209
  5. Conveying Modified Source Versions.
210

  
211
  You may convey a work based on the Program, or the modifications to
212
produce it from the Program, in the form of source code under the
213
terms of section 4, provided that you also meet all of these conditions:
214

  
215
    a) The work must carry prominent notices stating that you modified
216
    it, and giving a relevant date.
217

  
218
    b) The work must carry prominent notices stating that it is
219
    released under this License and any conditions added under section
220
    7.  This requirement modifies the requirement in section 4 to
221
    "keep intact all notices".
222

  
223
    c) You must license the entire work, as a whole, under this
224
    License to anyone who comes into possession of a copy.  This
225
    License will therefore apply, along with any applicable section 7
226
    additional terms, to the whole of the work, and all its parts,
227
    regardless of how they are packaged.  This License gives no
228
    permission to license the work in any other way, but it does not
229
    invalidate such permission if you have separately received it.
230

  
231
    d) If the work has interactive user interfaces, each must display
232
    Appropriate Legal Notices; however, if the Program has interactive
233
    interfaces that do not display Appropriate Legal Notices, your
234
    work need not make them do so.
235

  
236
  A compilation of a covered work with other separate and independent
237
works, which are not by their nature extensions of the covered work,
238
and which are not combined with it such as to form a larger program,
239
in or on a volume of a storage or distribution medium, is called an
240
"aggregate" if the compilation and its resulting copyright are not
241
used to limit the access or legal rights of the compilation's users
242
beyond what the individual works permit.  Inclusion of a covered work
243
in an aggregate does not cause this License to apply to the other
244
parts of the aggregate.
245

  
246
  6. Conveying Non-Source Forms.
247

  
248
  You may convey a covered work in object code form under the terms
249
of sections 4 and 5, provided that you also convey the
250
machine-readable Corresponding Source under the terms of this License,
251
in one of these ways:
252

  
253
    a) Convey the object code in, or embodied in, a physical product
254
    (including a physical distribution medium), accompanied by the
255
    Corresponding Source fixed on a durable physical medium
256
    customarily used for software interchange.
257

  
258
    b) Convey the object code in, or embodied in, a physical product
259
    (including a physical distribution medium), accompanied by a
260
    written offer, valid for at least three years and valid for as
261
    long as you offer spare parts or customer support for that product
262
    model, to give anyone who possesses the object code either (1) a
263
    copy of the Corresponding Source for all the software in the
264
    product that is covered by this License, on a durable physical
265
    medium customarily used for software interchange, for a price no
266
    more than your reasonable cost of physically performing this
267
    conveying of source, or (2) access to copy the
268
    Corresponding Source from a network server at no charge.
269

  
270
    c) Convey individual copies of the object code with a copy of the
271
    written offer to provide the Corresponding Source.  This
272
    alternative is allowed only occasionally and noncommercially, and
273
    only if you received the object code with such an offer, in accord
274
    with subsection 6b.
275

  
276
    d) Convey the object code by offering access from a designated
277
    place (gratis or for a charge), and offer equivalent access to the
278
    Corresponding Source in the same way through the same place at no
279
    further charge.  You need not require recipients to copy the
280
    Corresponding Source along with the object code.  If the place to
281
    copy the object code is a network server, the Corresponding Source
282
    may be on a different server (operated by you or a third party)
283
    that supports equivalent copying facilities, provided you maintain
284
    clear directions next to the object code saying where to find the
285
    Corresponding Source.  Regardless of what server hosts the
286
    Corresponding Source, you remain obligated to ensure that it is
287
    available for as long as needed to satisfy these requirements.
288

  
289
    e) Convey the object code using peer-to-peer transmission, provided
290
    you inform other peers where the object code and Corresponding
291
    Source of the work are being offered to the general public at no
292
    charge under subsection 6d.
293

  
294
  A separable portion of the object code, whose source code is excluded
295
from the Corresponding Source as a System Library, need not be
296
included in conveying the object code work.
297

  
298
  A "User Product" is either (1) a "consumer product", which means any
299
tangible personal property which is normally used for personal, family,
300
or household purposes, or (2) anything designed or sold for incorporation
301
into a dwelling.  In determining whether a product is a consumer product,
302
doubtful cases shall be resolved in favor of coverage.  For a particular
303
product received by a particular user, "normally used" refers to a
304
typical or common use of that class of product, regardless of the status
305
of the particular user or of the way in which the particular user
306
actually uses, or expects or is expected to use, the product.  A product
307
is a consumer product regardless of whether the product has substantial
308
commercial, industrial or non-consumer uses, unless such uses represent
309
the only significant mode of use of the product.
310

  
311
  "Installation Information" for a User Product means any methods,
312
procedures, authorization keys, or other information required to install
313
and execute modified versions of a covered work in that User Product from
314
a modified version of its Corresponding Source.  The information must
315
suffice to ensure that the continued functioning of the modified object
316
code is in no case prevented or interfered with solely because
317
modification has been made.
318

  
319
  If you convey an object code work under this section in, or with, or
320
specifically for use in, a User Product, and the conveying occurs as
321
part of a transaction in which the right of possession and use of the
322
User Product is transferred to the recipient in perpetuity or for a
323
fixed term (regardless of how the transaction is characterized), the
324
Corresponding Source conveyed under this section must be accompanied
325
by the Installation Information.  But this requirement does not apply
326
if neither you nor any third party retains the ability to install
327
modified object code on the User Product (for example, the work has
328
been installed in ROM).
329

  
330
  The requirement to provide Installation Information does not include a
331
requirement to continue to provide support service, warranty, or updates
332
for a work that has been modified or installed by the recipient, or for
333
the User Product in which it has been modified or installed.  Access to a
334
network may be denied when the modification itself materially and
335
adversely affects the operation of the network or violates the rules and
336
protocols for communication across the network.
337

  
338
  Corresponding Source conveyed, and Installation Information provided,
339
in accord with this section must be in a format that is publicly
340
documented (and with an implementation available to the public in
341
source code form), and must require no special password or key for
342
unpacking, reading or copying.
343

  
344
  7. Additional Terms.
345

  
346
  "Additional permissions" are terms that supplement the terms of this
347
License by making exceptions from one or more of its conditions.
348
Additional permissions that are applicable to the entire Program shall
349
be treated as though they were included in this License, to the extent
350
that they are valid under applicable law.  If additional permissions
351
apply only to part of the Program, that part may be used separately
352
under those permissions, but the entire Program remains governed by
353
this License without regard to the additional permissions.
354

  
355
  When you convey a copy of a covered work, you may at your option
356
remove any additional permissions from that copy, or from any part of
357
it.  (Additional permissions may be written to require their own
358
removal in certain cases when you modify the work.)  You may place
359
additional permissions on material, added by you to a covered work,
360
for which you have or can give appropriate copyright permission.
361

  
362
  Notwithstanding any other provision of this License, for material you
363
add to a covered work, you may (if authorized by the copyright holders of
364
that material) supplement the terms of this License with terms:
365

  
366
    a) Disclaiming warranty or limiting liability differently from the
367
    terms of sections 15 and 16 of this License; or
368

  
369
    b) Requiring preservation of specified reasonable legal notices or
370
    author attributions in that material or in the Appropriate Legal
371
    Notices displayed by works containing it; or
372

  
373
    c) Prohibiting misrepresentation of the origin of that material, or
374
    requiring that modified versions of such material be marked in
375
    reasonable ways as different from the original version; or
376

  
377
    d) Limiting the use for publicity purposes of names of licensors or
378
    authors of the material; or
379

  
380
    e) Declining to grant rights under trademark law for use of some
381
    trade names, trademarks, or service marks; or
382

  
383
    f) Requiring indemnification of licensors and authors of that
384
    material by anyone who conveys the material (or modified versions of
385
    it) with contractual assumptions of liability to the recipient, for
386
    any liability that these contractual assumptions directly impose on
387
    those licensors and authors.
388

  
389
  All other non-permissive additional terms are considered "further
390
restrictions" within the meaning of section 10.  If the Program as you
391
received it, or any part of it, contains a notice stating that it is
392
governed by this License along with a term that is a further
393
restriction, you may remove that term.  If a license document contains
394
a further restriction but permits relicensing or conveying under this
395
License, you may add to a covered work material governed by the terms
396
of that license document, provided that the further restriction does
397
not survive such relicensing or conveying.
398

  
399
  If you add terms to a covered work in accord with this section, you
400
must place, in the relevant source files, a statement of the
401
additional terms that apply to those files, or a notice indicating
402
where to find the applicable terms.
403

  
404
  Additional terms, permissive or non-permissive, may be stated in the
405
form of a separately written license, or stated as exceptions;
406
the above requirements apply either way.
407

  
408
  8. Termination.
409

  
410
  You may not propagate or modify a covered work except as expressly
411
provided under this License.  Any attempt otherwise to propagate or
412
modify it is void, and will automatically terminate your rights under
413
this License (including any patent licenses granted under the third
414
paragraph of section 11).
415

  
416
  However, if you cease all violation of this License, then your
417
license from a particular copyright holder is reinstated (a)
418
provisionally, unless and until the copyright holder explicitly and
419
finally terminates your license, and (b) permanently, if the copyright
420
holder fails to notify you of the violation by some reasonable means
421
prior to 60 days after the cessation.
422

  
423
  Moreover, your license from a particular copyright holder is
424
reinstated permanently if the copyright holder notifies you of the
425
violation by some reasonable means, this is the first time you have
426
received notice of violation of this License (for any work) from that
427
copyright holder, and you cure the violation prior to 30 days after
428
your receipt of the notice.
429

  
430
  Termination of your rights under this section does not terminate the
431
licenses of parties who have received copies or rights from you under
432
this License.  If your rights have been terminated and not permanently
433
reinstated, you do not qualify to receive new licenses for the same
434
material under section 10.
435

  
436
  9. Acceptance Not Required for Having Copies.
437

  
438
  You are not required to accept this License in order to receive or
439
run a copy of the Program.  Ancillary propagation of a covered work
440
occurring solely as a consequence of using peer-to-peer transmission
441
to receive a copy likewise does not require acceptance.  However,
442
nothing other than this License grants you permission to propagate or
443
modify any covered work.  These actions infringe copyright if you do
444
not accept this License.  Therefore, by modifying or propagating a
445
covered work, you indicate your acceptance of this License to do so.
446

  
447
  10. Automatic Licensing of Downstream Recipients.
448

  
449
  Each time you convey a covered work, the recipient automatically
450
receives a license from the original licensors, to run, modify and
451
propagate that work, subject to this License.  You are not responsible
452
for enforcing compliance by third parties with this License.
453

  
454
  An "entity transaction" is a transaction transferring control of an
455
organization, or substantially all assets of one, or subdividing an
456
organization, or merging organizations.  If propagation of a covered
457
work results from an entity transaction, each party to that
458
transaction who receives a copy of the work also receives whatever
459
licenses to the work the party's predecessor in interest had or could
460
give under the previous paragraph, plus a right to possession of the
461
Corresponding Source of the work from the predecessor in interest, if
462
the predecessor has it or can get it with reasonable efforts.
463

  
464
  You may not impose any further restrictions on the exercise of the
465
rights granted or affirmed under this License.  For example, you may
466
not impose a license fee, royalty, or other charge for exercise of
467
rights granted under this License, and you may not initiate litigation
468
(including a cross-claim or counterclaim in a lawsuit) alleging that
469
any patent claim is infringed by making, using, selling, offering for
470
sale, or importing the Program or any portion of it.
471

  
472
  11. Patents.
473

  
474
  A "contributor" is a copyright holder who authorizes use under this
475
License of the Program or a work on which the Program is based.  The
476
work thus licensed is called the contributor's "contributor version".
477

  
478
  A contributor's "essential patent claims" are all patent claims
479
owned or controlled by the contributor, whether already acquired or
480
hereafter acquired, that would be infringed by some manner, permitted
481
by this License, of making, using, or selling its contributor version,
482
but do not include claims that would be infringed only as a
483
consequence of further modification of the contributor version.  For
484
purposes of this definition, "control" includes the right to grant
485
patent sublicenses in a manner consistent with the requirements of
486
this License.
487

  
488
  Each contributor grants you a non-exclusive, worldwide, royalty-free
489
patent license under the contributor's essential patent claims, to
490
make, use, sell, offer for sale, import and otherwise run, modify and
491
propagate the contents of its contributor version.
492

  
493
  In the following three paragraphs, a "patent license" is any express
494
agreement or commitment, however denominated, not to enforce a patent
495
(such as an express permission to practice a patent or covenant not to
496
sue for patent infringement).  To "grant" such a patent license to a
497
party means to make such an agreement or commitment not to enforce a
498
patent against the party.
499

  
500
  If you convey a covered work, knowingly relying on a patent license,
501
and the Corresponding Source of the work is not available for anyone
502
to copy, free of charge and under the terms of this License, through a
503
publicly available network server or other readily accessible means,
504
then you must either (1) cause the Corresponding Source to be so
505
available, or (2) arrange to deprive yourself of the benefit of the
506
patent license for this particular work, or (3) arrange, in a manner
507
consistent with the requirements of this License, to extend the patent
508
license to downstream recipients.  "Knowingly relying" means you have
509
actual knowledge that, but for the patent license, your conveying the
510
covered work in a country, or your recipient's use of the covered work
511
in a country, would infringe one or more identifiable patents in that
512
country that you have reason to believe are valid.
513
  
514
  If, pursuant to or in connection with a single transaction or
515
arrangement, you convey, or propagate by procuring conveyance of, a
516
covered work, and grant a patent license to some of the parties
517
receiving the covered work authorizing them to use, propagate, modify
518
or convey a specific copy of the covered work, then the patent license
519
you grant is automatically extended to all recipients of the covered
520
work and works based on it.
521

  
522
  A patent license is "discriminatory" if it does not include within
523
the scope of its coverage, prohibits the exercise of, or is
524
conditioned on the non-exercise of one or more of the rights that are
525
specifically granted under this License.  You may not convey a covered
526
work if you are a party to an arrangement with a third party that is
527
in the business of distributing software, under which you make payment
528
to the third party based on the extent of your activity of conveying
529
the work, and under which the third party grants, to any of the
530
parties who would receive the covered work from you, a discriminatory
531
patent license (a) in connection with copies of the covered work
532
conveyed by you (or copies made from those copies), or (b) primarily
533
for and in connection with specific products or compilations that
534
contain the covered work, unless you entered into that arrangement,
535
or that patent license was granted, prior to 28 March 2007.
536

  
537
  Nothing in this License shall be construed as excluding or limiting
538
any implied license or other defenses to infringement that may
539
otherwise be available to you under applicable patent law.
540

  
541
  12. No Surrender of Others' Freedom.
542

  
543
  If conditions are imposed on you (whether by court order, agreement or
544
otherwise) that contradict the conditions of this License, they do not
545
excuse you from the conditions of this License.  If you cannot convey a
546
covered work so as to satisfy simultaneously your obligations under this
547
License and any other pertinent obligations, then as a consequence you may
548
not convey it at all.  For example, if you agree to terms that obligate you
549
to collect a royalty for further conveying from those to whom you convey
550
the Program, the only way you could satisfy both those terms and this
551
License would be to refrain entirely from conveying the Program.
552

  
553
  13. Use with the GNU Affero General Public License.
554

  
555
  Notwithstanding any other provision of this License, you have
556
permission to link or combine any covered work with a work licensed
557
under version 3 of the GNU Affero General Public License into a single
558
combined work, and to convey the resulting work.  The terms of this
559
License will continue to apply to the part which is the covered work,
560
but the special requirements of the GNU Affero General Public License,
561
section 13, concerning interaction through a network will apply to the
562
combination as such.
563

  
564
  14. Revised Versions of this License.
565

  
566
  The Free Software Foundation may publish revised and/or new versions of
567
the GNU General Public License from time to time.  Such new versions will
568
be similar in spirit to the present version, but may differ in detail to
569
address new problems or concerns.
570

  
571
  Each version is given a distinguishing version number.  If the
572
Program specifies that a certain numbered version of the GNU General
573
Public License "or any later version" applies to it, you have the
574
option of following the terms and conditions either of that numbered
575
version or of any later version published by the Free Software
576
Foundation.  If the Program does not specify a version number of the
577
GNU General Public License, you may choose any version ever published
578
by the Free Software Foundation.
579

  
580
  If the Program specifies that a proxy can decide which future
581
versions of the GNU General Public License can be used, that proxy's
582
public statement of acceptance of a version permanently authorizes you
583
to choose that version for the Program.
584

  
585
  Later license versions may give you additional or different
586
permissions.  However, no additional obligations are imposed on any
587
author or copyright holder as a result of your choosing to follow a
588
later version.
589

  
590
  15. Disclaimer of Warranty.
591

  
592
  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
593
APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
594
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
595
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
596
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
597
PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
598
IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
599
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
600

  
601
  16. Limitation of Liability.
602

  
603
  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
604
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
605
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
606
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
607
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
608
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
609
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
610
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
611
SUCH DAMAGES.
612

  
613
  17. Interpretation of Sections 15 and 16.
614

  
615
  If the disclaimer of warranty and limitation of liability provided
616
above cannot be given local legal effect according to their terms,
617
reviewing courts shall apply local law that most closely approximates
618
an absolute waiver of all civil liability in connection with the
619
Program, unless a warranty or assumption of liability accompanies a
620
copy of the Program in return for a fee.
621

  
622
		     END OF TERMS AND CONDITIONS
623

  
624
	    How to Apply These Terms to Your New Programs
625

  
626
  If you develop a new program, and you want it to be of the greatest
627
possible use to the public, the best way to achieve this is to make it
628
free software which everyone can redistribute and change under these terms.
629

  
630
  To do so, attach the following notices to the program.  It is safest
631
to attach them to the start of each source file to most effectively
632
state the exclusion of warranty; and each file should have at least
633
the "copyright" line and a pointer to where the full notice is found.
634

  
635
    <one line to give the program's name and a brief idea of what it does.>
636
    Copyright (C) <year>  <name of author>
637

  
638
    This program is free software: you can redistribute it and/or modify
639
    it under the terms of the GNU General Public License as published by
640
    the Free Software Foundation, either version 3 of the License, or
641
    (at your option) any later version.
642

  
643
    This program is distributed in the hope that it will be useful,
644
    but WITHOUT ANY WARRANTY; without even the implied warranty of
645
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
646
    GNU General Public License for more details.
647

  
648
    You should have received a copy of the GNU General Public License
649
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
650

  
651
Also add information on how to contact you by electronic and paper mail.
652

  
653
  If the program does terminal interaction, make it output a short
654
notice like this when it starts in an interactive mode:
655

  
656
    <program>  Copyright (C) <year>  <name of author>
657
    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
658
    This is free software, and you are welcome to redistribute it
659
    under certain conditions; type `show c' for details.
660

  
661
The hypothetical commands `show w' and `show c' should show the appropriate
662
parts of the General Public License.  Of course, your program's commands
663
might be different; for a GUI interface, you would use an "about box".
664

  
665
  You should also get your employer (if you work as a programmer) or school,
666
if any, to sign a "copyright disclaimer" for the program, if necessary.
667
For more information on this, and how to apply and follow the GNU GPL, see
668
<http://www.gnu.org/licenses/>.
669

  
670
  The GNU General Public License does not permit incorporating your program
671
into proprietary programs.  If your program is a subroutine library, you
672
may consider it more useful to permit linking proprietary applications with
673
the library.  If this is what you want to do, use the GNU Lesser General
674
Public License instead of this License.  But first, please read
675
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
676

  
/dev/null
1
This suite requires the following python modules to be present on the system:
2

  
3
   python-lxml: uses lxml.objectify to parse the XML metadata
4
   pydns: used for reverse DNS lookup to get a hint about a user's preferred IdP
5
   IPy: used for IP map manipulation
6

  
/dev/null
1
# -*- coding: utf-8 -*-
2
from lxml.objectify import parse
3
from django.utils.translation import ugettext as _
4
from django.utils.translation import ugettext_lazy as _l
5
from django.utils.translation import get_language
6
import re
7
import random
8

  
9

  
10
# A catalog of the institution categories. The order in which they appear
11
# here is the same as they will appear on the web.
12
institution_categories = (
13
      ('university', _l("Universities")),
14
      ('tei',  _l("Technological educational institutes")),
15
      ('school',  _l("Other academic institutions")),
16
      ('institute', _l("Research institutes")),
17
      ('other', _l("Other")),
18
      ('test', _l("Testing")),
19
)
20

  
21
xpath_ns = {'ds': 'http://www.w3.org/2000/09/xmldsig#',
22
            'md': 'urn:oasis:names:tc:SAML:2.0:metadata',
23
            'mdrpi': 'urn:oasis:names:tc:SAML:metadata:rpi',
24
            'mdui': 'urn:oasis:names:tc:SAML:metadata:ui',
25
            'shibmd': 'urn:mace:shibboleth:metadata:1.0',
26
            'xi': 'http://www.w3.org/2001/XInclude',
27
            'xsi': 'http://www.w3.org/2001/XMLSchema-instance'}
28

  
29

  
30
class ShibbolethMetadata:
31
    """Basic object holding the shibboleth metadata"""
32

  
33
    def __init__(self,filename):
34
        """Initialize a ShibbolethMetadata object
35

  
36
        arguments:
37
            filename -- The location of the XML document containing Shibboleth metadata
38

  
39
        """
40

  
41
        self.mdtree = parse(filename)
42
        self.metadata = self.mdtree.getroot()
43

  
44
    def getEntities(self, entity_type = None, augmented=False):
45
        """Returns an EntityList holding all Entities (of requested type) found 
46
        in the metadata, perhaps augmented in to the corresponding object type
47
        """
48
        if entity_type is "idp":
49
            entityfilter = "IDPSSODescriptor"
50
        elif entity_type is "sp":
51
            entityfilter = "SPSSODescriptor"
52
        # elif entity_type is "aa":
53
        #     entityfilter = "AttributeAuthorityDescriptor"
54
        else:
55
            entityfilter = None
56

  
57
        def filtertype(entity):
58
            if entityfilter is None:
59
                return True
60
            elif hasattr(entity, entityfilter):
61
                return True
62
            else:
63
                return False
64

  
65
        kots = filter(filtertype, self.metadata.xpath("//md:EntityDescriptor",
66
                                                     namespaces=xpath_ns))
67

  
68
        if augmented:
69
            return EntityList([ Entity.construct_augmented_entity(kot)
70
                                for kot in kots])
71
        else:
72
            return EntityList([ Entity(kot) for kot in kots])
73

  
74
    def getIdps(self):
75
        """Returns an IdpList holding all Identity Providers found in the metadata"""
76
        idps = self.getEntities("idp")
77

  
78
        return IdpList([ IdentityProvider.create_from_entity(kot) for kot in idps ])
79

  
80
    def getSps(self):
81
        """Returns an IdpList holding all Identity Providers found in the metadata"""
82
        sps = self.getEntities("sp")
83

  
84
        return SpList([ ServiceProvider.create_from_entity(kot) for kot in sps ])
85

  
86
    def getPath(self, entity):
87
        if isinstance(entity, Entity) and hasattr(entity, 'el'):
88
            return self.mdtree.getpath(entity.el)
89
        else:
90
            raise Exception('Can not get path for entity %s' % str(entity))
91

  
92

  
93
class EntityList(list):
94
    """Class holding a list of SAML Entities"""
95

  
96
    def __init__(self,entity_list):
97
        """Create a new list of SAML Entities
98

  
99
        arguments:
100
            entity_list -- a list of SAML Entities
101

  
102
        """
103
        list.__init__(self,entity_list)
104

  
105
    def __getitem__(self, key):
106
        # Allow for "entitylist['a_provider_entityid'] lookups
107
        try:
108
            return filter(lambda x: x.id == key, self)[0]
109
        except:
110
            return None
111

  
112
    def getGroups(self):
113
        """Returns the list of known groups entities are grouped by (in 
114
        EntitiesDescriptor elements)
115

  
116
        """
117
        groups = set()
118
        for x in self:
119
            groups.update(x.groups)
120
        return groups
121

  
122
    def getEntities(self, lang=None, group=None, logosize=tuple()):
123
        """Returns a list of entities, where each entity is represented by a 
124
        dict carrying the localized name, url, logo and entity ID attributes
125

  
126
        """
127
        if not lang:
128
            lang = get_language()
129

  
130
        if group:
131
            entities = filter(lambda x: group in x.groups, self)
132
        else:
133
            entities = self
134

  
135
        entities = sorted(entities)
136

  
137
        return map(lambda x: {'name': x.getName(lang),
138
                              'url': x.getURL(lang),
139
                              'logo': x.getLogo(targetsize=logosize),
140
                              'id': x.id },
141
                   entities)
142

  
143
    def getEntitiesByGroup(self, lang=None, exclude=[]):
144
        """Returns a sequence of tuples of the form:
145
        
146
        (group, [ entity1, entity2, ...])
147
        
148
        where the second element of each tuple is the return value of
149
        getEntities()
150

  
151
        """
152
        groups = filter(lambda x: x not in exclude, self.getGroups())
153

  
154
        entities = []
155
        for group in groups:
156
            entities.append(self.getEntities(lang=lang, group=group))
157

  
158
        return zip(groups, entities)
159

  
160

  
161
class IdpList(EntityList):
162
    """Class holding a list of SAML Identity Providers"""
163

  
164
    def __init__(self,idplist):
165
        """Create a new list of Identity Providers
166

  
167
        arguments:
168
            idplist -- a list of IdentityProvider instances
169

  
170
        """
171
        super(EntityList, self).__init__(idplist)
172

  
173
    def getCategories(self):
174
        """Returns the list of known categories of Identity Providers"""
175

  
176
        return sorted(set(map(lambda x: x.getType(), self)))
177

  
178
    def getCategoryIdps(self, category):
179
        """Returns the list of known identity providers for a given category"""
180

  
181
        return filter(lambda x: x.getType() == category, self)
182

  
183
    def getIdpForScope(self, scope):
184
        """Returns the identity provider matching a given scope"""
185

  
186
        try:
187
            return filter(lambda x: x.matchesScope(scope), self)[0]
188
        except:
189
            return None
190

  
191
    def getIdpsByCategory(self, lang=None, exclude=None):
192
        """Returns a sequence of tuples of the form:
193
        
194
        (category, [ idp1, idp2, ...])
195
        
196
        where idpX is a dict { 'name': name, 'id': entityid }
197

  
198
        The list of idps is sorted by name
199

  
200
        """
201
        if not lang:
202
            lang = get_language()
203

  
204
        if exclude:
205
            validcats = filter(lambda x: x[0] not in exclude, institution_categories)
206
        else:
207
            validcats = institution_categories
208

  
209
        cats = map(lambda x: x[0], validcats) 
210

  
211
        categories = map(lambda x: { 'id': x[0], 'name': x[1] }, validcats)
212

  
213
        idps = []
214

  
215
        for category in cats:
216
            catidps = sorted(self.getCategoryIdps(category))
217
            idps.append(map(lambda x: {
218
                    'name': x.getName(lang),
219
                    'url': x.getURL(lang),
220
                    'id': x.id },
221
                    catidps))
222

  
223
        return zip(categories, idps)
224

  
225

  
226
class SpList(EntityList):
227
    """Class holding a list of SAML Service Providers"""
228

  
229
    def __init__(self,splist):
230
        """Create a new list of Service Providers
231

  
232
        arguments:
233
            splist -- a list of ServiceProvider instances
234

  
235
        """
236
        super(EntityList, self).__init__(splist)
237

  
238

  
239
class Entity:
240
    """Basic class holding a SAML Entity"""
241

  
242
    def __init__(self,el):
243
        """Create a new Entity instance
244
        arguments:
245
            el -- An lxml.objectify.Element holding an EntityDescriptor for a SAML Entity
246

  
247
        """
248

  
249
        self.el = el
250
        self.name = {} # Holds the Entity's name in a form { language: string }
251
        self.url = {}
252
        self.logo = {}
253
        self.id = self.el.get('entityID')
254
        self.groups = set(el.xpath("ancestor::md:EntitiesDescriptor/@Name", namespaces=xpath_ns))
255

  
256
        # Initialize the contact details
257
        self.contact = { 'givenName': '', 'surName': '', 'company': '', 'email': '', 'telephone': '', 'url': '' }
258

  
259
        # Get the institution's name
260
        try:
261
            for name in self.el.Organization.OrganizationDisplayName:
262
                self.name[name.get('{http://www.w3.org/XML/1998/namespace}lang')] = name.text
263
        except:
264
            self.name = {'en': "no name"}
265

  
266
        try:
267
            for url in self.el.Organization.OrganizationURL:
268
                self.url[url.get('{http://www.w3.org/XML/1998/namespace}lang')] = url.text
269
        except:
270
            pass
271

  
272
        # Fill in the contact details
273
        try:
274
            for contact in self.el.ContactPerson:
275
                if contact.get('contactType') == "support":
276
                    # We're not sure these details even exists, but since that would
277
                    # require a set of nested checks, exception catching is more
278
                    # clean.
279
                    try:
280
                        self.contact['email'] = contact.EmailAddress.text
281
                    except:
282
                        pass
283

  
284
                    try:
285
                        self.contact['telephone'] = contact.TelephoneNumber.text
286
                    except:
287
                        pass
288
        except:
289
            pass
290

  
291
    def __cmp__ (self,other):
292
        # Alphabetic sorting by name
293
        return cmp(self.getName(get_language()), other.getName(get_language()))
294

  
295
    def __repr__(self):
296
        return "Entity: \"" + self.name['en'] + '" (' + self.id + ')'
297

  
298
    @classmethod
299
    def create_from_entity(cls, entity):
300
        if issubclass(cls, entity.__class__) and hasattr(entity, 'el'):
301
            return cls(entity.el)
302
        else:
303
            raise Exception('Can not instantiate %s from %s' % (cls,
304
                                                                str(entity)))
305

  
306
    @staticmethod
307
    def construct_augmented_entity(el):
308
        elcls = el.__class__
309
        # should do isinstance() but we do not import whole lxl.objectify
310
        if ("%s.%s" % (elcls.__module__, elcls.__name__)) == \
311
                "lxml.objectify.ObjectifiedElement":
312
            if hasattr(el, "IDPSSODescriptor"):
313
                aug_ent_cls = IdentityProvider
314
            elif hasattr(el, "SPSSODescriptor"):
315
                aug_ent_cls = ServiceProvider
316
            # elif hasattr(el, "AttributeAuthorityDescriptor"):
317
            #     pass
318
            else:
319
                aug_ent_cls = None
320

  
321
            if aug_ent_cls is not None:
322
                return aug_ent_cls(el)
323

  
324
        raise Exception("Can not instantiate augmented Entity from %s" %
325
                             el)
326

  
327
    def getName(self,lang=None):
328
        if not lang:
329
            lang = get_language()
330

  
331
        try:
332
            return self.name[lang]
333
        except:
334
            return self.name['en']
335

  
336
    def getURL(self,lang=None):
337
        if not lang:
338
            lang = get_language()
339

  
340
        try:
341
            return self.url[lang]
342
        except:
343
            pass
344

  
345
        try:
346
            return self.url['en']
347
        except:
348
            pass
349

  
350
        return None
351

  
352
    def getLogo(self,targetsize=tuple()):
353

  
354
        if not self.logo:
355
            return None
356

  
357
        # get (x, y) closest to target (a, b)
358
        if isinstance(targetsize, tuple) and \
359
                len(targetsize) is 2 and \
360
                [isinstance(i, int) for i in targetsize]:
361
            dimensions = min(self.logo.keys(),
362
                             key = lambda x: abs(x[0]-targetsize[0]) + \
363
                                 abs(x[1]-targetsize[1])
364
                             )
365
        else:
366
            dimensions = random.choice(self.logo.keys())
367

  
368
        return { 'width': dimensions[0],
369
                 'height': dimensions[1],
370
                 'data': self.logo[dimensions] }
371

  
372

  
373
class IdentityProvider(Entity):
374
    """Class holding a SAML Identity Provider"""
375

  
376
    def __init__(self,idpel):
377
        """Create a new IdentityProvider instance
378
        arguments:
379
            idpel -- An lxml.objectify.Element holding an EntityDescriptor for a shibboleth IdP
380

  
381
        """
382

  
383
        Entity.__init__(self, idpel)
384

  
385
        # Dictionary to hold all ArtifactResolutionService definitions, by Binding
386
        self.ars = {}
387
        # Dictionary to hold all SingleLogoutService definitions, by Binding
388
        self.slo = {}
389
        # Dictionary to hold all ManageNameIDService definitions, by Binding
390
        self.mnid = {}
391
        # Dictionary to hold all SingleSignOnService definitions, by Binding
392
        self.sso = {}
393

  
394
        # Get all SingleSignOnService definitions (required)
395
        for entry in self.el.IDPSSODescriptor.SingleSignOnService:
396
            self.sso[entry.get('Binding')] = entry.get('Location')
397
        try:
398
            # Get all SingleLogoutService definitions
399
            for entry in self.el.IDPSSODescriptor.SingleLogoutService:
400
                self.slo[entry.get('Binding')] = entry.get('Location')
401
            # Get all ArtifactResolutionService definitions
402
            for entry in self.el.IDPSSODescriptor.ArtifactResolutionService:
403
                self.ars[entry.get('Binding')] = entry.get('Location')
404
            # Get all ManageNameIDService definitions
405
            for entry in self.el.IDPSSODescriptor.ManageNameIDService:
406
                self.mnid[entry.get('Binding')] = entry.get('Location')
407
        except:
408
            pass
409

  
410
        # Override self.name, self.url with mdui:DisplayName, mdui:DisplayName
411
        # also add logo from mdui:Logo
412
        try:
413
            ui = self.el.IDPSSODescriptor.\
414
                Extensions['{urn:oasis:names:tc:SAML:metadata:ui}UIInfo']
415
            # Override self.name with mdui:DisplayName or self.atcs.name
416
            if hasattr(ui, 'DisplayName'):
417
                self.name = {}
418
                for name in ui.DisplayName:
419
                    self.name[name.get(
420
                            '{http://www.w3.org/XML/1998/namespace}lang'
421
                            )] = name.text
422
            # Override self.url with mdui:InformationURL
423
            if hasattr(ui,'InformationURL'):
424
                self.url = {}
425
                for url in ui.InformationURL:
426
                    self.url[url.get(
427
                            '{http://www.w3.org/XML/1998/namespace}lang'
428
                            )] = url.text
429
            # Also add logo from mdui:Logo
430
            if hasattr(ui, 'Logo'):
431
                for logo in ui.Logo:
432
                    self.logo[(int(logo.get('width')),
433
                               int(logo.get('height')))] = logo.text
434
        except:
435
            pass
436

  
437
    def __repr__(self):
438
        return "IDP: \"" + self.name['en'] + '" (' + self.id + ')'
439

  
440
    def getType(self):
441
        """Returns the type (category) of the current IdP"""
442

  
443
        # Some heuristics to determine the IdP type, based on the
444
        # institution's name in english.
445
        if self.name['en'].lower().find('test') >= 0:
446
            return "test"
447
        elif self.name['en'].lower().find('university') >= 0:
448
            return "university"
449
        elif self.name['en'].lower().find('school of fine arts') >= 0:
450
            return "university"
451
        elif self.name['en'].lower().find('technological') >= 0:
452
            return "tei"
453
        elif re.findall(r'(ecclesiastical|school|academy)', self.name['en'].lower()):
454
            return "school"
455
        elif re.findall(r'(institute|cent(er|re)|ncsr|foundat|bservat)', self.name['en'].lower()):
456
            return "institute"
457
        else:
458
            return "other"
459
    
460
    def getScope(self):
461
        """Returns the scope of the current IdP"""
462

  
463
        scopes = filter(lambda x: x.tag == "{urn:mace:shibboleth:metadata:1.0}Scope", self.el.IDPSSODescriptor.Extensions.getchildren())
464
        return scopes[0].text
465

  
466
    def matchesScope(self,scope):
467
        """Checks wheter the current IdPs scope matches the given string"""
468

  
469
        myscope = self.getScope()
470
        
471
        # Append a trailing '$', to align the regexp with the string end
472
        if myscope[-1] != '$':
473
            myscope += '$'
474

  
475
        if re.search(myscope, scope):
476
            return True
477

  
478
        return False
479

  
480

  
481
class ServiceProvider(Entity):
482
    """Class holding a SAML Service Provider"""
483

  
484
    def __init__(self,spel):
485
        """Create a new ServiceProvider instance
486
        arguments:
487
            spel -- An lxml.objectify.Element holding an EntityDescriptor for a shibboleth SP
488

  
489
        """
490

  
491
        Entity.__init__(self, spel)
492

  
493
        # Dictionary to hold all AssertionConsumerService definitions, by Binding
494
        self.acs = {}
495
        # Dictionary to hold all SingleLogoutService definitions, by Binding
496
        self.slo = {}
497
        # Dictionary to hold all ManageNameIDService definitions, by Binding
498
        self.mnid = {}
499
        # Dictionary to hold all AttributeConsumingService definitions, by ServiceName
500
        self.atcs = {}
501

  
502
        # Get all AssertionConsumerService definitions (required)
503
        for entry in self.el.SPSSODescriptor.AssertionConsumerService:
504
            self.acs[entry.get('Binding')] = entry.get('Location')
505
        # Get all SingleLogoutService definitions
506
        try:
507
            for entry in self.el.SPSSODescriptor.SingleLogoutService:
508
                self.slo[entry.get('Binding')] = entry.get('Location')
509
        except:
510
            pass
511
        # Get all ManageNameIDService definitions
512
        try:
513
            for entry in self.el.SPSSODescriptor.ManageNameIDService:
514
                self.mnid[entry.get('Binding')] = entry.get('Location')
515
        except:
516
            pass
517
        # Get all AttributeConsumingService definitions
518
        try:
519
            for entry in self.el.SPSSODescriptor.AttributeConsumingService:
520
                atcs_name = {}
521
                if hasattr(entry, 'ServiceName'):
522
                    for name in entry.ServiceName:
523
                        atcs_name[name.get(
524
                                '{http://www.w3.org/XML/1998/namespace}lang'
525
                                )] = name.text
526
                atcs_descr = {}
527
                if hasattr(entry, 'ServiceDescription'):
528
                    for descr in entry.ServiceDescription:
529
                        atcs_descr[descr.get(
530
                                '{http://www.w3.org/XML/1998/namespace}lang'
531
                                )] = descr.text
532
                req_attr = {}
533
                if hasattr(entry, 'RequestedAttribute'):
534
                    for attr in entry.RequestedAttribute:
535
                        req_attr[(attr.get('Name'),
536
                                  attr.get('NameFormat'))] = {
537
                            'name': attr.get('FriendlyName'),
538
                            'required':
539
                                True if \
540
                                attr.get('isRequired').lower == 'true' \
541
                                else False
542
                            }
543
                if 'en' in atcs_name:
544
                    self.atcs[atcs_name['en']] = type(
545
                        self.__class__.__name__ + \
546
                            '.AttributeConsumingService',
547
                        (object,),
548
                        { 'name': atcs_name,
549
                          'descr': atcs_descr,
550
                          'attr': req_attr }
551
                        )
552
        except AttributeError:
553
            pass
554

  
555
        # Override self.name with self.atcs.name
556
        if self.atcs:
557
            self.name = [s.name for s in self.atcs.values()][0]
558

  
559
        try:
560
            ui = self.el.SPSSODescriptor.\
561
                Extensions['{urn:oasis:names:tc:SAML:metadata:ui}UIInfo']
562
            # Override self.name with mdui:DisplayName
563
            if hasattr(ui, 'DisplayName'):
564
                self.name = {}
565
                for name in ui.DisplayName:
566
                    self.name[name.get(
567
                            '{http://www.w3.org/XML/1998/namespace}lang'
568
                            )] = name.text
569
            # Override self.url with mdui:InformationURL
570
            if hasattr(ui,'InformationURL'):
571
                self.url = {}
572
                for url in ui.InformationURL:
573
                    self.url[url.get(
574
                            '{http://www.w3.org/XML/1998/namespace}lang'
575
                            )] = url.text
576
            # Also add logo from mdui:Logo
577
            if hasattr(ui, 'Logo'):
578
                for logo in ui.Logo:
579
                    self.logo[(int(logo.get('width')),
580
                               int(logo.get('height')))] = logo.text
581
        except AttributeError:
582
            pass
583

  
584
    def __repr__(self):
585
        return "SP: \"" + self.name['en'] + '" (' + self.id + ')'
/dev/null
1
import re 
2
import DNS
3
from IPy import IP
4

  
5
ipspaces = {
6
     'admin.grnet.gr':	['195.251.29.0/24', '83.212.9.64/26',
7
                         '2001:648:2320:1::/64', '2001:648:2340:1::/64'],
8

  
9
     'aegean.gr':   	['83.212.68.0/22', '195.251.128.0/18', 
10
                         '195.251.160.0/20', '195.251.176.0/21',
11
                         '2001:648:2050::/48'],
12

  
13
     'aua.gr':	        ['143.233.54.0/24', '143.233.182.0/23',
14
                         '143.233.184.0/22', '143.233.188.0/23', 
15
                         '143.233.204.0/24'],
16

  
17
     'aueb.gr':	        ['195.251.255.0/24', '2001:648:2020::/48'],
18

  
19
     'auth.gr':	        ['155.207.0.0/16', '2001:648:2800::/48'],
20

  
21
     'cti.gr':	        ['150.140.0.0/17'],
22

  
23
     'duth.gr':	        ['192.108.114.0/24', '193.92.204.0/22', 
24
                         '193.92.208.0/20', '193.92.224.0/22', 
25
                         '193.92.236.0/22', '193.92.240.0/21', 
26
                         '193.92.248.0/22', '195.130.122.0/24',
27
                         '2001:648:2E80::/48'],
28

  
29
     'edunet.gr':   	['195.134.100.0/26'],
30

  
31
     'ekt.gr':	        ['194.177.214.0/23'],
32

  
33
     'teicrete.gr': 	['193.92.8.0/22', '83.212.45.0/24', 
34
                         '83.212.46.0/23', '2001:648:2C10::/48'],
35

  
36
     'hua.gr':	        ['83.212.240.0/23', '83.212.242.0/24', 
37
                         '195.130.90.0/23', '195.251.30.0/23', 
38
                         '83.212.240.0/23', '83.212.242.0/24', 
39
                         '195.130.90.0/23', '195.251.30.0/23'],
40

  
41
     'ntua.gr':	        ['147.102.0.0/16', '2001:648:2000::/48', 
42
                         '2001:648:2001::/48'],
43

  
44
     'teiath.gr':	    ['195.130.96.0/20', '83.212.64.0/22',
45
                         '2001:648:2E00::/48'],
46

  
47
     'chania.teicrete.gr':	    ['194.177.198.0/24'],
48

  
49
     'teimes.gr':	    ['194.177.216.0/24'],
50

  
51
     'teiser.gr':	    ['195.130.67.0/24'],
52

  
53
     'tuc.gr':	        ['147.27.0.0/16', '194.177.198.0/24', 
54
                         '147.27.0.0/16', '194.177.198.0/24'],
55

  
56
     'uoc.gr':      	['147.52.0.0/16', '192.103.20.0/24', 
57
                         '194.177.197.0/24', '2001:648:2C00::/48'],
58

  
59
     'uoa.gr':	        ['84.38.0.0/20', '87.239.232.0/21', 
60
                         '88.197.0.0/17', '195.130.123.0/24', 
61
                         '195.134.64.0/18'],
62

  
63
     'uoi.gr':	        ['83.212.192.0/21', '83.212.200.0/23', 
64
                         '195.130.112.0/21', '195.130.120.0/23', 
65
                         '195.251.192.0/21', '195.251.200.0/23'],
66

  
67
     'uop.gr':	        ['195.251.38.0/23', '195.251.46.0/23', 
68
                         '195.251.112.0/23', '195.251.38.0/23', 
69
                         '195.251.46.0/23', '195.251.112.0/23'],
70

  
71
     'upatras.gr':	    ['150.140.0.0/16', '195.251.54.128/25'],
72

  
73
     'uth.gr':	        ['83.212.32.0/22', '83.212.34.0/23', 
74
                         '83.212.43.0/24', '194.177.200.0/21', 
75
                         '195.251.17.0/24', '195.251.18.0/23'],
76

  
77
}
78

  
79
def urldecode(string):
80
    urlenc = re.compile(r'%([0-9a-fA-F]{2})')
81
    return urlenc.sub(lambda x: chr(int(x.group(1), 16)), string)
82

  
83
def getUserRealm(ipaddr):
84
    ip = IP(ipaddr)
85

  
86
    # First try the address ranges:
87
    for scope, ranges in ipspaces.items():
88
        if filter(lambda x: ip.overlaps(x), ranges):
89
            return scope
90

  
91
    # Then try DNS
92
    revip = ip.reverseName().rstrip('.') # Important, DnsRequest breaks
93
                                         # with a trailing dot
94
    DNS.ParseResolvConf()
95
    req = DNS.DnsRequest(name=revip, qtype='PTR', timeout=2)
96

  
97
    try:
98
        res = req.req()
99
    except DNS.DNSError:
100
        return
101

  
102
    if res.answers:
103
        return res.answers[0]['data']
104
    
/dev/null
1
import time
2

  
3
from os import environ
4

  
5
from aai.models import *
6
from aai.util import *
7
from grnet_aai.idpmap import *
8
from django.shortcuts import render_to_response
9
from django.conf import settings
10
from django.http import HttpResponse, HttpResponseRedirect, HttpResponseNotFound
11
from django.utils.http import urlencode
12
from django.template.loader import render_to_string
13

  
14

  
15
def index(request):
16
    return render_to_response("index.html")
17

  
18
def idp_list(request):
19
    metadata = ShibbolethMetadata(settings.SHIB_METADATA)
20
    idps = metadata.getIdps()
21
    idplist = idps.getIdpsByCategory(exclude=('wayf', 'test'))
22

  
23
    return render_to_response("idp_list.html", { 'idplist' : idplist } )
24

  
25
def sp_list(request):
26
    metadata = ShibbolethMetadata(settings.SHIB_METADATA)
27
    sps = metadata.getSps()
28
    splist = sps.getEntitiesByGroup()
29
    # splist_other = entities in the top group
30
    splist_other = [i[1] for i in splist if i[0] == 'http://www.grnet.gr/aai'][0]
31
    # fitlerids = entity.id for entities not in the top group
32
    filterids = [o['id'] for i in splist for o in i[1] if i[0] != 'http://www.grnet.gr/aai']
33
    # filter out entities not in the top group from splist_other
34
    splist_other_new = filter(lambda x: x['id'] not in filterids, splist_other)
35
    # replace top group with filtered out version in splist
36
    splist.insert(splist.index(('http://www.grnet.gr/aai', splist_other)), ('other', splist_other_new))
37
    splist.remove(('http://www.grnet.gr/aai', splist_other))
38

  
39
    return render_to_response("sp_list.html", { 'splist' : splist } )
40

  
41
def entity_list(request, group = None):
42
    if group is not None:
43
        group = "http://aai.grnet.gr%s" % request.path_info
44
    metadata = ShibbolethMetadata(settings.SHIB_METADATA)
45
    entities = metadata.getEntities(augmented=True)
46
    entlist = entities.getEntities(group=group, logosize=(100,100))
47

  
48
    return render_to_response("entity_list.html", { 'entlist' : entlist,
49
                                                    'group' : group } )
50

  
51
def static(request, path):
52
    # A catch-all view, trying to render all our static pages or give a 404 
53
    try:
54
        return render_to_response(path + ".html")
55
    except:
56
        return HttpResponseNotFound(render_to_string("404.html"))
57

  
58
def json(request, path):
59
    try:
60
        with open(settings.IDPDISCO_FEEDS + "/" + path, 'r') as feedfile:
61
            data = feedfile.read()
62
        if "callback" in request.REQUEST:
63
            # a jsonp response!
64
            data = "%s(%s);" % ( request.REQUEST["callback"], data )
65
            return HttpResponse(data, "text/javascript")
66
        else:
67
            return HttpResponse(data, "application/json")
68
    except:
69
        return HttpResponseNotFound(render_to_string("404.html"))
70

  
71
def support(request, mode="support"):
72
    # This gets triggered when a user's attributes fail to be accepted 
73
    # by a service provider. The aim is to produce a help page, indicating
74
    # the user's home institution contact details.
75

  
76
    opts = {}
77
    userIdp = None
78

  
79
    # Check to see whether _redirect_user_idp is set. This cookie will include
80
    # The user's selected IdP
81
    if settings.IDP_COOKIE in request.COOKIES.keys():
82
        userIdp = urldecode(request.COOKIES[settings.IDP_COOKIE])
83
    elif settings.LAST_IDP_COOKIE in request.COOKIES.keys():
84
        userIdp = urldecode(request.COOKIES[settings.LAST_IDP_COOKIE])
85

  
86
    if userIdp:
87
        # Check to see if this is one of the old WAYF entries and map it to a
88
        # new entityID instead.
89
        if userIdp in idpmap.keys():
90
            userIdp = idpmap[userIdp]
91
            
92
        # Get the corresponding IdentityProvider instance
93
        idp = ShibbolethMetadata(settings.SHIB_METADATA).getIdps()[userIdp]
94

  
95
        if idp:
96
            opts['idp'] = idp
97
            opts['idpname'] = idp.getName()
98

  
99
    if mode == "help":
100
        response = render_to_response("help.html", opts)
101
    else:
... This diff was truncated because it exceeds the maximum size that can be displayed.

Also available in: Unified diff