aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-passwords.h
blob: 2fa345839e1874ab6220595da03c746befd174dd (plain) (blame)
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
/*
 * e-passwords.h
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 */

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU Lesser General Public
 * License as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 * USA.
 */

#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
#error "Only <e-util/e-util.h> should be included directly."
#endif

#ifndef EDS_DISABLE_DEPRECATED

#ifndef _E_PASSWORD_H_
#define _E_PASSWORD_H_

#include <gtk/gtk.h>

G_BEGIN_DECLS

/*
 * initialization is now implicit when you call any of the functions
 * below, although this is only correct if the functions are called
 * from the main thread.
 */
void e_passwords_init (void);

void        e_passwords_set_online (gint state);
void        e_passwords_remember_password (const gchar *unused, const gchar *key);
void        e_passwords_add_password      (const gchar *key, const gchar *passwd);
gchar       *e_passwords_get_password      (const gchar *unused, const gchar *key);
void        e_passwords_forget_password   (const gchar *unused, const gchar *key);

typedef enum {
    E_PASSWORDS_REMEMBER_NEVER,
    E_PASSWORDS_REMEMBER_SESSION,
    E_PASSWORDS_REMEMBER_FOREVER,
    E_PASSWORDS_REMEMBER_MASK = 0xf,

    /* option bits */
    E_PASSWORDS_SECRET = 1 << 8,
    E_PASSWORDS_REPROMPT = 1 << 9,
    E_PASSWORDS_ONLINE = 1<<10, /* only ask if we're online */
    E_PASSWORDS_DISABLE_REMEMBER = 1<<11, /* disable the 'remember password' checkbox */
    E_PASSWORDS_PASSPHRASE = 1<<12 /* We are asking a passphrase */
} EPasswordsRememberType;

gchar *      e_passwords_ask_password     (const gchar *title,
                       const gchar *unused,
                       const gchar *key,
                       const gchar *prompt,
                       EPasswordsRememberType remember_type,
                       gboolean *remember,
                       GtkWindow *parent);

G_END_DECLS

#endif /* _E_PASSWORD_H_ */

#endif /* EDS_DISABLE_DEPRECATED */