/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
2898.3.5 by James Henstridge
Add copyright headers to new files
1
# Copyright (C) 2007 Canonical Ltd
2
#
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
#
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
#
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
"""Functions to manage the user's Launchpad user ID.
18
19
This allows the user to configure their Launchpad user ID once, rather
20
than once for each place that needs to take it into account.
21
"""
22
3777.1.12 by Aaron Bentley
Enable configuring ssh auth from launchpad-login, with auto-upgrade.
23
from bzrlib import errors, trace
24
from bzrlib.config import AuthenticationConfig, GlobalConfig
2898.3.1 by James Henstridge
API for storing and retrieving the Launchpad user ID that will be used
25
from bzrlib.transport import get_transport
26
27
28
LAUNCHPAD_BASE = 'https://launchpad.net/'
29
30
31
class UnknownLaunchpadUsername(errors.BzrError):
32
    _fmt = "The user name %(user)s is not registered on Launchpad."
33
34
35
class NoRegisteredSSHKeys(errors.BzrError):
36
    _fmt = "The user %(user)s has not registered any SSH keys with Launchpad."
37
38
3777.1.12 by Aaron Bentley
Enable configuring ssh auth from launchpad-login, with auto-upgrade.
39
class MismatchedUsernames(errors.BzrError):
40
41
    _fmt = ('bazaar.conf and authentication.conf disagree about launchpad'
42
            ' account name.  Please re-run launchpad-login.')
43
44
2898.3.6 by James Henstridge
Rename function arguments that are only intended for use by the tests.
45
def get_lp_login(_config=None):
3777.1.15 by Aaron Bentley
Update docs
46
    """Return the user's Launchpad username.
47
48
    :raises: MismatchedUsername if authentication.conf and bazaar.conf
49
        disagree about username.
50
    """
2898.3.6 by James Henstridge
Rename function arguments that are only intended for use by the tests.
51
    if _config is None:
52
        _config = GlobalConfig()
53
3777.1.12 by Aaron Bentley
Enable configuring ssh auth from launchpad-login, with auto-upgrade.
54
    username = _config.get_user_option('launchpad_username')
3777.1.18 by Aaron Bentley
Fix None handling wrt auth upgrades
55
    if username is not None:
56
        auth = AuthenticationConfig()
3777.1.20 by Aaron Bentley
Include staging in launchpad-login authentication.
57
        auth_usernames = _get_auth_user(auth)
58
        for auth_username in auth_usernames.values():
59
            if auth_username is not None and auth_username != username:
60
                raise MismatchedUsernames()
3777.1.18 by Aaron Bentley
Fix None handling wrt auth upgrades
61
        # Auto-upgrading
3777.1.20 by Aaron Bentley
Include staging in launchpad-login authentication.
62
        if None in auth_usernames.values():
63
            trace.note('Setting ssh/sftp usernames for launchpad.net.')
3777.1.18 by Aaron Bentley
Fix None handling wrt auth upgrades
64
            _set_auth_user(username, auth)
3777.1.12 by Aaron Bentley
Enable configuring ssh auth from launchpad-login, with auto-upgrade.
65
    return username
66
67
68
def _set_global_option(username, _config=None):
69
    if _config is None:
70
        _config = GlobalConfig()
71
    _config.set_user_option('launchpad_username', username)
2898.3.6 by James Henstridge
Rename function arguments that are only intended for use by the tests.
72
73
74
def set_lp_login(username, _config=None):
2898.3.1 by James Henstridge
API for storing and retrieving the Launchpad user ID that will be used
75
    """Set the user's Launchpad username"""
3777.1.12 by Aaron Bentley
Enable configuring ssh auth from launchpad-login, with auto-upgrade.
76
    _set_global_option(username, _config)
77
    _set_auth_user(username)
78
79
80
def _get_auth_user(auth=None):
81
    if auth is None:
82
        auth = AuthenticationConfig()
3777.1.20 by Aaron Bentley
Include staging in launchpad-login authentication.
83
    return {'production': auth.get_user('ssh', 'bazaar.launchpad.net'),
84
            'staging': auth.get_user('ssh', 'bazaar.staging.launchpad.net'),}
3777.1.12 by Aaron Bentley
Enable configuring ssh auth from launchpad-login, with auto-upgrade.
85
86
def _set_auth_user(username, auth=None):
87
    if auth is None:
88
        auth = AuthenticationConfig()
89
    auth.set_credentials(
3777.1.14 by Aaron Bentley
Adjust for new set_credentials signature
90
        'Launchpad', 'bazaar.launchpad.net', username, 'ssh')
3777.1.20 by Aaron Bentley
Include staging in launchpad-login authentication.
91
    auth.set_credentials(
92
        'Launchpad Staging', 'bazaar.staging.launchpad.net', username, 'ssh')
2898.3.6 by James Henstridge
Rename function arguments that are only intended for use by the tests.
93
94
95
def check_lp_login(username, _transport=None):
2898.3.1 by James Henstridge
API for storing and retrieving the Launchpad user ID that will be used
96
    """Check whether the given Launchpad username is okay.
97
2934.1.1 by Ian Clatworthy
(James Henstridge) add a command for managing the Launchpad user ID
98
    This will check for both existence and whether the user has
2898.3.1 by James Henstridge
API for storing and retrieving the Launchpad user ID that will be used
99
    uploaded SSH keys.
100
    """
2898.3.6 by James Henstridge
Rename function arguments that are only intended for use by the tests.
101
    if _transport is None:
102
        _transport = get_transport(LAUNCHPAD_BASE)
2898.3.1 by James Henstridge
API for storing and retrieving the Launchpad user ID that will be used
103
104
    try:
2898.3.6 by James Henstridge
Rename function arguments that are only intended for use by the tests.
105
        data = _transport.get_bytes('~%s/+sshkeys' % username)
2898.3.1 by James Henstridge
API for storing and retrieving the Launchpad user ID that will be used
106
    except errors.NoSuchFile:
107
        raise UnknownLaunchpadUsername(user=username)
108
109
    if not data:
110
        raise NoRegisteredSSHKeys(user=username)