Erik Grinaker is sharing code with you

Bitbucket is a code hosting site. Unlimited public and private repositories. Free for small teams.

Don't show this again

erikg / Revelation

Revelation is a password manager for the GNOME desktop, released under the GNU GPL license. It stores all your accounts and passwords in a single, secure place, and gives you access to it through a user-friendly graphical interface.

Clone this repository (size: 2.1 MB): HTTPS / SSH
hg clone https://bitbucket.org/erikg/revelation
hg clone ssh://hg@bitbucket.org/erikg/revelation

Revelation / src / lib / entry.py

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
#
# Revelation 0.3.2 - a password manager for GNOME 2
# http://oss.codepoet.no/revelation/
# $Id$
#
# Module containing entry information
#
#
# Copyright (c) 2003-2004 Erik Grinaker
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#

import revelation, copy, gobject, gtk, time


ENTRY_FOLDER                    = "folder"
ENTRY_ACCOUNT_CREDITCARD        = "creditcard"
ENTRY_ACCOUNT_CRYPTOKEY         = "cryptokey"
ENTRY_ACCOUNT_DATABASE          = "database"
ENTRY_ACCOUNT_DOOR              = "door"
ENTRY_ACCOUNT_EMAIL             = "email"
ENTRY_ACCOUNT_FTP               = "ftp"
ENTRY_ACCOUNT_GENERIC           = "generic"
ENTRY_ACCOUNT_PHONE             = "phone"
ENTRY_ACCOUNT_SHELL             = "shell"
ENTRY_ACCOUNT_WEBSITE           = "website"


FIELD_GENERIC_CERTIFICATE       = "generic-certificate"
FIELD_GENERIC_CODE              = "generic-code"
FIELD_GENERIC_DATABASE          = "generic-database"
FIELD_GENERIC_DOMAIN            = "generic-domain"
FIELD_GENERIC_EMAIL             = "generic-email"
FIELD_GENERIC_HOSTNAME          = "generic-hostname"
FIELD_GENERIC_KEYFILE           = "generic-keyfile"
FIELD_GENERIC_LOCATION          = "generic-location"
FIELD_GENERIC_PASSWORD          = "generic-password"
FIELD_GENERIC_PIN               = "generic-pin"
FIELD_GENERIC_PORT              = "generic-port"
FIELD_GENERIC_URL               = "generic-url"
FIELD_GENERIC_USERNAME          = "generic-username"

FIELD_CREDITCARD_CARDTYPE       = "creditcard-cardtype"
FIELD_CREDITCARD_CARDNUMBER     = "creditcard-cardnumber"
FIELD_CREDITCARD_CCV            = "creditcard-ccv"
FIELD_CREDITCARD_EXPIRYDATE     = "creditcard-expirydate"

FIELD_PHONE_PHONENUMBER         = "phone-phonenumber"


FIELD_TYPE_EMAIL                = "email"
FIELD_TYPE_PASSWORD             = "password"
FIELD_TYPE_TEXT                 = "text"
FIELD_TYPE_URL                  = "url"


ENTRYDATA = {
        ENTRY_FOLDER                    : {
                "name"          : "Folder",
                "icon"          : revelation.stock.STOCK_FOLDER,
                "fields"        : []
        },

        ENTRY_ACCOUNT_CREDITCARD        : {
                "name"          : "Creditcard",
                "icon"          : revelation.stock.STOCK_ACCOUNT_CREDITCARD,
                "fields"        : [ FIELD_CREDITCARD_CARDTYPE, FIELD_CREDITCARD_CARDNUMBER, FIELD_CREDITCARD_EXPIRYDATE, FIELD_CREDITCARD_CCV, FIELD_GENERIC_PIN ]
        },

        ENTRY_ACCOUNT_CRYPTOKEY         : {
                "name"          : "Crypto Key",
                "icon"          : revelation.stock.STOCK_ACCOUNT_CRYPTOKEY,
                "fields"        : [ FIELD_GENERIC_HOSTNAME, FIELD_GENERIC_CERTIFICATE, FIELD_GENERIC_KEYFILE, FIELD_GENERIC_PASSWORD ]
        },

        ENTRY_ACCOUNT_DATABASE          : {
                "name"          : "Database",
                "icon"          : revelation.stock.STOCK_ACCOUNT_DATABASE,
                "fields"        : [ FIELD_GENERIC_HOSTNAME, FIELD_GENERIC_USERNAME, FIELD_GENERIC_PASSWORD, FIELD_GENERIC_DATABASE ]
        },

        ENTRY_ACCOUNT_DOOR              : {
                "name"          : "Door lock",
                "icon"          : revelation.stock.STOCK_ACCOUNT_DOOR,
                "fields"        : [ FIELD_GENERIC_LOCATION, FIELD_GENERIC_CODE ]
        },

        ENTRY_ACCOUNT_EMAIL             : {
                "name"          : "Email",
                "icon"          : revelation.stock.STOCK_ACCOUNT_EMAIL,
                "fields"        : [ FIELD_GENERIC_EMAIL, FIELD_GENERIC_HOSTNAME, FIELD_GENERIC_USERNAME, FIELD_GENERIC_PASSWORD ]
        },

        ENTRY_ACCOUNT_FTP               : {
                "name"          : "FTP",
                "icon"          : revelation.stock.STOCK_ACCOUNT_FTP,
                "fields"        : [ FIELD_GENERIC_HOSTNAME, FIELD_GENERIC_PORT, FIELD_GENERIC_USERNAME, FIELD_GENERIC_PASSWORD ]
        },

        ENTRY_ACCOUNT_GENERIC           : {
                "name"          : "Generic",
                "icon"          : revelation.stock.STOCK_ACCOUNT,
                "fields"        : [ FIELD_GENERIC_HOSTNAME, FIELD_GENERIC_USERNAME, FIELD_GENERIC_PASSWORD ]
        },

        ENTRY_ACCOUNT_PHONE             : {
                "name"          : "Phone",
                "icon"          : revelation.stock.STOCK_ACCOUNT_PHONE,
                "fields"        : [ FIELD_PHONE_PHONENUMBER, FIELD_GENERIC_PIN ]
        },

        ENTRY_ACCOUNT_SHELL             : {
                "name"          : "Shell",
                "icon"          : revelation.stock.STOCK_ACCOUNT_SHELL,
                "fields"        : [ FIELD_GENERIC_HOSTNAME, FIELD_GENERIC_DOMAIN, FIELD_GENERIC_USERNAME, FIELD_GENERIC_PASSWORD ]
        },

        ENTRY_ACCOUNT_WEBSITE           : {
                "name"          : "Website",
                "icon"          : revelation.stock.STOCK_ACCOUNT_WEBSITE,
                "fields"        : [ FIELD_GENERIC_URL, FIELD_GENERIC_USERNAME, FIELD_GENERIC_PASSWORD ]
        }
}


FIELDDATA = {
        FIELD_GENERIC_CODE              : {
                "name"          : "Code",
                "type"          : FIELD_TYPE_PASSWORD,
                "description"   : "A code used to provide access to something"
        },

        FIELD_GENERIC_CERTIFICATE       : {
                "name"          : "Certificate",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "A certificate, such as an X.509 SSL Certificate"
        },

        FIELD_GENERIC_DATABASE          : {
                "name"          : "Database",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "A database name"
        },

        FIELD_GENERIC_DOMAIN            : {
                "name"          : "Domain",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "An Internet or logon domain, like amazon.com or a Windows logon domain"
        },

        FIELD_GENERIC_EMAIL             : {
                "name"          : "Email address",
                "type"          : FIELD_TYPE_EMAIL,
                "description"   : "An email address"
        },

        FIELD_GENERIC_HOSTNAME          : {
                "name"          : "Hostname",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "The name of a computer, like computer.domain.com or MYCOMPUTER"
        },

        FIELD_GENERIC_KEYFILE           : {
                "name"          : "Key File",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "A key file, used for authentication for example via ssh or to encrypt X.509 certificates"
        },

        FIELD_GENERIC_LOCATION          : {
                "name"          : "Location",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "A physical location, like office entrance"
        },

        FIELD_GENERIC_PASSWORD          : {
                "name"          : "Password",
                "type"          : FIELD_TYPE_PASSWORD,
                "description"   : "A secret word or character combination used for proving you have access"
        },

        FIELD_GENERIC_PIN               : {
                "name"          : "PIN",
                "type"          : FIELD_TYPE_PASSWORD,
                "description"   : "A Personal Identification Number, a numeric code used for credit cards, phones etc"
        },

        FIELD_GENERIC_PORT              : {
                "name"          : "Port number",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "A network port number, used to access network services directly"
        },

        FIELD_GENERIC_URL               : {
                "name"          : "URL",
                "type"          : FIELD_TYPE_URL,
                "description"   : "A Uniform Resource Locator, such as a web-site address"
        },

        FIELD_GENERIC_USERNAME          : {
                "name"          : "Username",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "A name or other identification used to identify yourself"
        },

        FIELD_CREDITCARD_CARDTYPE       : {
                "name"          : "Card type",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "The type of creditcard, like MasterCard or VISA"
        },

        FIELD_CREDITCARD_CARDNUMBER     : {
                "name"          : "Card number",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "The number of a creditcard, usually a 16-digit number"
        },

        FIELD_CREDITCARD_CCV            : {
                "name"          : "CCV number",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "A Credit Card Verification number, normally a 3-digit code found on the back of a card"
        },

        FIELD_CREDITCARD_EXPIRYDATE     : {
                "name"          : "Expiry date",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "The month that the credit card validity expires"
        },

        FIELD_PHONE_PHONENUMBER         : {
                "name"          : "Phone number",
                "type"          : FIELD_TYPE_TEXT,
                "description"   : "A telephone number"
        }
}



class EntryError(Exception):
        pass

class EntryFieldError(EntryError):
        pass

class EntryTypeError(EntryError):
        pass



class Entry(gobject.GObject):
        "An entry object"

        def __init__(self, type = ENTRY_FOLDER):
                gobject.GObject.__init__(self)

                self.name               = ""
                self.description        = ""
                self.type               = None
                self.typename           = ""
                self.updated            = 0
                self.icon               = None
                self.fields             = {}
                self.oldfields          = {}

                self.set_type(type)


        def copy(self):
                "Create a copy of the entry"

                return copy.deepcopy(self)


        def convert_generic(self):
                "Converts to a generic account, tries to keep as much data as possible"

                user            = None
                password        = None
                hostname        = None

                # handle special conversions
                if self.type == ENTRY_ACCOUNT_CREDITCARD:
                        user            = self.get_field(FIELD_CREDITCARD_CARDNUMBER).value
                        password        = self.get_field(FIELD_GENERIC_PIN).value

                elif self.type == ENTRY_ACCOUNT_CRYPTOKEY:
                        user            = self.get_field(FIELD_GENERIC_KEYFILE).value

                elif self.type == ENTRY_ACCOUNT_DATABASE:
                        hostname        = self.get_field(FIELD_GENERIC_HOSTNAME).value

                        if self.get_field(FIELD_GENERIC_DATABASE).value != "":
                                hostname = self.get_field(FIELD_GENERIC_DATABASE).value + "@" + hostname

                elif self.type == ENTRY_ACCOUNT_DOOR:
                        password        = self.get_field(FIELD_GENERIC_CODE).value
                        hostname        = self.get_field(FIELD_GENERIC_LOCATION).value

                elif self.type == ENTRY_ACCOUNT_FTP:
                        hostname        = "ftp://" + self.get_field(FIELD_GENERIC_HOSTNAME).value

                        if self.get_field(FIELD_GENERIC_PORT).value != "":
                                hostname += ":" + self.get_field(FIELD_GENERIC_PORT).value

                elif self.type == ENTRY_ACCOUNT_PHONE:
                        user            = self.get_field(FIELD_PHONE_PHONENUMBER).value
                        password        = self.get_field(FIELD_GENERIC_PIN).value

                elif self.type == ENTRY_ACCOUNT_WEBSITE:
                        url             = self.get_field(FIELD_GENERIC_URL).value


                # do a normal entry conversion,
                # and apply special conversions
                self.set_type(ENTRY_ACCOUNT_GENERIC)

                if user is not None:
                        self.set_field(FIELD_GENERIC_USERNAME, user)

                if password is not None:
                        self.set_field(FIELD_GENERIC_PASSWORD, password)

                if hostname is not None:
                        self.set_field(FIELD_GENERIC_HOSTNAME, hostname)


        def get_field(self, id):
                "Get one of the entrys fields"

                try:
                        return self.fields[id]

                except KeyError:
                        raise EntryFieldError


        def get_fields(self):
                "Get all the entrys fields"

                fields = []
                for id in ENTRYDATA[self.type]["fields"]:
                        fields.append(self.get_field(id))

                return fields


        def get_updated_age(self):
                "Get the age of an entry"

                return revelation.misc.timediff_simple(self.updated)


        def get_updated_iso(self):
                "Get the update time in ISO format"

                return time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(self.updated))


        def has_field(self, id):
                "Checks if the entry has a particular field"

                return self.fields.has_key(id)


        def set_field(self, id, value):
                "Sets one of the entries fields to a value"

                if not self.fields.has_key(id):
                        raise EntryFieldError

                self.fields[id] = Field(id, value)


        def set_type(self, type):
                "Sets the type of entry"

                # backwards-compatability
                if type == "usenet":
                        type = ENTRY_ACCOUNT_GENERIC


                if not ENTRYDATA.has_key(type):
                        raise EntryTypeError

                # convert entry to new type
                self.type       = type
                self.typename   = ENTRYDATA[type]["name"]
                self.icon       = ENTRYDATA[type]["icon"]

                # store current field values
                for id, field in self.fields.items():
                        self.oldfields[id] = field

                # set up new fields
                self.fields = {}
                for id in ENTRYDATA[self.type]["fields"]:
                        if self.oldfields.has_key(id):
                                self.fields[id] = self.oldfields[id]
                        else:
                                self.fields[id] = Field(id)



class Field(gobject.GObject):
        "An entry field object"

        def __init__(self, id = None, value = ""):
                gobject.GObject.__init__(self)

                self.id                 = id
                self.value              = value
                self.type               = FIELDDATA[id]["type"]
                self.name               = FIELDDATA[id]["name"]
                self.description        = FIELDDATA[id]["description"]


        def generate_display_widget(self):
                "Generates a widget for displaying the field"

                if self.type == FIELD_TYPE_EMAIL:
                        widget = revelation.widget.HRef("mailto:" + self.value, revelation.misc.escape_markup(self.value))

                elif self.type == FIELD_TYPE_PASSWORD:
                        widget = revelation.widget.PasswordLabel(revelation.misc.escape_markup(self.value))

                elif self.type == FIELD_TYPE_URL:
                        widget = revelation.widget.HRef(self.value, revelation.misc.escape_markup(self.value))

                else:
                        widget = revelation.widget.Label(revelation.misc.escape_markup(self.value))
                        widget.set_selectable(gtk.TRUE)

                return widget


        def generate_edit_widget(self):
                "Generates a widget for editing the field"

                if self.id == FIELD_GENERIC_PASSWORD:
                        entry = revelation.widget.PasswordEntryGenerate()

                elif self.type == FIELD_TYPE_PASSWORD:
                        entry = revelation.widget.PasswordEntry()

                else:
                        entry = revelation.widget.Entry()

                entry.set_text(self.value)

                return entry



def get_entry_list():
        "Returns a sorted list of all available entry types"

        typelist = ENTRYDATA.keys()
        typelist.sort()

        return typelist