840
908
except ImportError:
843
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
911
user_encoding = osutils.get_user_encoding()
912
realname = username = getpass.getuser().decode(user_encoding)
844
913
except UnicodeDecodeError:
845
914
raise errors.BzrError("Can't decode username as %s." % \
846
bzrlib.user_encoding)
848
917
return realname, (username + '@' + socket.gethostname())
920
def parse_username(username):
921
"""Parse e-mail username and return a (name, address) tuple."""
922
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
924
return (username, '')
926
return (match.group(1), match.group(2))
851
929
def extract_email_address(e):
852
930
"""Return just the address part of an email string.
854
That is just the user@domain part, nothing else.
932
That is just the user@domain part, nothing else.
855
933
This part is required to contain only ascii characters.
856
934
If it can't be extracted, raises an error.
858
936
>>> extract_email_address('Jane Tester <jane@test.com>')
861
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
939
name, email = parse_username(e)
863
941
raise errors.NoEmailInUsername(e)
867
945
class TreeConfig(IniBasedConfig):
868
946
"""Branch configuration data associated with its contents, not location"""
948
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
869
950
def __init__(self, branch):
951
self._config = branch._get_config()
870
952
self.branch = branch
872
954
def _get_parser(self, file=None):
873
955
if file is not None:
874
956
return IniBasedConfig._get_parser(file)
875
return self._get_config()
877
def _get_config(self):
879
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
881
except errors.NoSuchFile:
882
obj = ConfigObj(encoding='utf=8')
957
return self._config._get_configobj()
885
959
def get_option(self, name, section=None, default=None):
886
960
self.branch.lock_read()
888
obj = self._get_config()
890
if section is not None:
962
return self._config.get_option(name, section, default)
896
964
self.branch.unlock()
899
966
def set_option(self, value, name, section=None):
900
967
"""Set a per-branch configuration option"""
901
968
self.branch.lock_write()
903
cfg_obj = self._get_config()
908
obj = cfg_obj[section]
910
cfg_obj[section] = {}
911
obj = cfg_obj[section]
913
out_file = StringIO()
914
cfg_obj.write(out_file)
916
self.branch.control_files.put('branch.conf', out_file)
970
self._config.set_option(value, name, section)
918
972
self.branch.unlock()
975
class AuthenticationConfig(object):
976
"""The authentication configuration file based on a ini file.
978
Implements the authentication.conf file described in
979
doc/developers/authentication-ring.txt.
982
def __init__(self, _file=None):
983
self._config = None # The ConfigObj
985
self._filename = authentication_config_filename()
986
self._input = self._filename = authentication_config_filename()
988
# Tests can provide a string as _file
989
self._filename = None
992
def _get_config(self):
993
if self._config is not None:
996
# FIXME: Should we validate something here ? Includes: empty
997
# sections are useless, at least one of
998
# user/password/password_encoding should be defined, etc.
1000
# Note: the encoding below declares that the file itself is utf-8
1001
# encoded, but the values in the ConfigObj are always Unicode.
1002
self._config = ConfigObj(self._input, encoding='utf-8')
1003
except configobj.ConfigObjError, e:
1004
raise errors.ParseConfigError(e.errors, e.config.filename)
1008
"""Save the config file, only tests should use it for now."""
1009
conf_dir = os.path.dirname(self._filename)
1010
ensure_config_dir_exists(conf_dir)
1011
self._get_config().write(file(self._filename, 'wb'))
1013
def _set_option(self, section_name, option_name, value):
1014
"""Set an authentication configuration option"""
1015
conf = self._get_config()
1016
section = conf.get(section_name)
1019
section = conf[section]
1020
section[option_name] = value
1023
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1025
"""Returns the matching credentials from authentication.conf file.
1027
:param scheme: protocol
1029
:param host: the server address
1031
:param port: the associated port (optional)
1033
:param user: login (optional)
1035
:param path: the absolute path on the server (optional)
1037
:param realm: the http authentication realm (optional)
1039
:return: A dict containing the matching credentials or None.
1041
- name: the section name of the credentials in the
1042
authentication.conf file,
1043
- user: can't be different from the provided user if any,
1044
- scheme: the server protocol,
1045
- host: the server address,
1046
- port: the server port (can be None),
1047
- path: the absolute server path (can be None),
1048
- realm: the http specific authentication realm (can be None),
1049
- password: the decoded password, could be None if the credential
1050
defines only the user
1051
- verify_certificates: https specific, True if the server
1052
certificate should be verified, False otherwise.
1055
for auth_def_name, auth_def in self._get_config().items():
1056
if type(auth_def) is not configobj.Section:
1057
raise ValueError("%s defined outside a section" % auth_def_name)
1059
a_scheme, a_host, a_user, a_path = map(
1060
auth_def.get, ['scheme', 'host', 'user', 'path'])
1063
a_port = auth_def.as_int('port')
1067
raise ValueError("'port' not numeric in %s" % auth_def_name)
1069
a_verify_certificates = auth_def.as_bool('verify_certificates')
1071
a_verify_certificates = True
1074
"'verify_certificates' not boolean in %s" % auth_def_name)
1077
if a_scheme is not None and scheme != a_scheme:
1079
if a_host is not None:
1080
if not (host == a_host
1081
or (a_host.startswith('.') and host.endswith(a_host))):
1083
if a_port is not None and port != a_port:
1085
if (a_path is not None and path is not None
1086
and not path.startswith(a_path)):
1088
if (a_user is not None and user is not None
1089
and a_user != user):
1090
# Never contradict the caller about the user to be used
1095
# Prepare a credentials dictionary with additional keys
1096
# for the credential providers
1097
credentials = dict(name=auth_def_name,
1104
password=auth_def.get('password', None),
1105
verify_certificates=a_verify_certificates)
1106
# Decode the password in the credentials (or get one)
1107
self.decode_password(credentials,
1108
auth_def.get('password_encoding', None))
1109
if 'auth' in debug.debug_flags:
1110
trace.mutter("Using authentication section: %r", auth_def_name)
1113
if credentials is None:
1114
# No credentials were found in authentication.conf, try the fallback
1115
# credentials stores.
1116
credentials = credential_store_registry.get_fallback_credentials(
1117
scheme, host, port, user, path, realm)
1121
def set_credentials(self, name, host, user, scheme=None, password=None,
1122
port=None, path=None, verify_certificates=None,
1124
"""Set authentication credentials for a host.
1126
Any existing credentials with matching scheme, host, port and path
1127
will be deleted, regardless of name.
1129
:param name: An arbitrary name to describe this set of credentials.
1130
:param host: Name of the host that accepts these credentials.
1131
:param user: The username portion of these credentials.
1132
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1134
:param password: Password portion of these credentials.
1135
:param port: The IP port on the host that these credentials apply to.
1136
:param path: A filesystem path on the host that these credentials
1138
:param verify_certificates: On https, verify server certificates if
1140
:param realm: The http authentication realm (optional).
1142
values = {'host': host, 'user': user}
1143
if password is not None:
1144
values['password'] = password
1145
if scheme is not None:
1146
values['scheme'] = scheme
1147
if port is not None:
1148
values['port'] = '%d' % port
1149
if path is not None:
1150
values['path'] = path
1151
if verify_certificates is not None:
1152
values['verify_certificates'] = str(verify_certificates)
1153
if realm is not None:
1154
values['realm'] = realm
1155
config = self._get_config()
1157
for section, existing_values in config.items():
1158
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1159
if existing_values.get(key) != values.get(key):
1163
config.update({name: values})
1166
def get_user(self, scheme, host, port=None, realm=None, path=None,
1167
prompt=None, ask=False, default=None):
1168
"""Get a user from authentication file.
1170
:param scheme: protocol
1172
:param host: the server address
1174
:param port: the associated port (optional)
1176
:param realm: the realm sent by the server (optional)
1178
:param path: the absolute path on the server (optional)
1180
:param ask: Ask the user if there is no explicitly configured username
1183
:param default: The username returned if none is defined (optional).
1185
:return: The found user.
1187
credentials = self.get_credentials(scheme, host, port, user=None,
1188
path=path, realm=realm)
1189
if credentials is not None:
1190
user = credentials['user']
1196
# Create a default prompt suitable for most cases
1197
prompt = scheme.upper() + ' %(host)s username'
1198
# Special handling for optional fields in the prompt
1199
if port is not None:
1200
prompt_host = '%s:%d' % (host, port)
1203
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1208
def get_password(self, scheme, host, user, port=None,
1209
realm=None, path=None, prompt=None):
1210
"""Get a password from authentication file or prompt the user for one.
1212
:param scheme: protocol
1214
:param host: the server address
1216
:param port: the associated port (optional)
1220
:param realm: the realm sent by the server (optional)
1222
:param path: the absolute path on the server (optional)
1224
:return: The found password or the one entered by the user.
1226
credentials = self.get_credentials(scheme, host, port, user, path,
1228
if credentials is not None:
1229
password = credentials['password']
1230
if password is not None and scheme is 'ssh':
1231
trace.warning('password ignored in section [%s],'
1232
' use an ssh agent instead'
1233
% credentials['name'])
1237
# Prompt user only if we could't find a password
1238
if password is None:
1240
# Create a default prompt suitable for most cases
1241
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1242
# Special handling for optional fields in the prompt
1243
if port is not None:
1244
prompt_host = '%s:%d' % (host, port)
1247
password = ui.ui_factory.get_password(prompt,
1248
host=prompt_host, user=user)
1251
def decode_password(self, credentials, encoding):
1253
cs = credential_store_registry.get_credential_store(encoding)
1255
raise ValueError('%r is not a known password_encoding' % encoding)
1256
credentials['password'] = cs.decode_password(credentials)
1260
class CredentialStoreRegistry(registry.Registry):
1261
"""A class that registers credential stores.
1263
A credential store provides access to credentials via the password_encoding
1264
field in authentication.conf sections.
1266
Except for stores provided by bzr itself, most stores are expected to be
1267
provided by plugins that will therefore use
1268
register_lazy(password_encoding, module_name, member_name, help=help,
1269
fallback=fallback) to install themselves.
1271
A fallback credential store is one that is queried if no credentials can be
1272
found via authentication.conf.
1275
def get_credential_store(self, encoding=None):
1276
cs = self.get(encoding)
1281
def is_fallback(self, name):
1282
"""Check if the named credentials store should be used as fallback."""
1283
return self.get_info(name)
1285
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1286
path=None, realm=None):
1287
"""Request credentials from all fallback credentials stores.
1289
The first credentials store that can provide credentials wins.
1292
for name in self.keys():
1293
if not self.is_fallback(name):
1295
cs = self.get_credential_store(name)
1296
credentials = cs.get_credentials(scheme, host, port, user,
1298
if credentials is not None:
1299
# We found some credentials
1303
def register(self, key, obj, help=None, override_existing=False,
1305
"""Register a new object to a name.
1307
:param key: This is the key to use to request the object later.
1308
:param obj: The object to register.
1309
:param help: Help text for this entry. This may be a string or
1310
a callable. If it is a callable, it should take two
1311
parameters (registry, key): this registry and the key that
1312
the help was registered under.
1313
:param override_existing: Raise KeyErorr if False and something has
1314
already been registered for that key. If True, ignore if there
1315
is an existing key (always register the new value).
1316
:param fallback: Whether this credential store should be
1319
return super(CredentialStoreRegistry,
1320
self).register(key, obj, help, info=fallback,
1321
override_existing=override_existing)
1323
def register_lazy(self, key, module_name, member_name,
1324
help=None, override_existing=False,
1326
"""Register a new credential store to be loaded on request.
1328
:param module_name: The python path to the module. Such as 'os.path'.
1329
:param member_name: The member of the module to return. If empty or
1330
None, get() will return the module itself.
1331
:param help: Help text for this entry. This may be a string or
1333
:param override_existing: If True, replace the existing object
1334
with the new one. If False, if there is already something
1335
registered with the same key, raise a KeyError
1336
:param fallback: Whether this credential store should be
1339
return super(CredentialStoreRegistry, self).register_lazy(
1340
key, module_name, member_name, help,
1341
info=fallback, override_existing=override_existing)
1344
credential_store_registry = CredentialStoreRegistry()
1347
class CredentialStore(object):
1348
"""An abstract class to implement storage for credentials"""
1350
def decode_password(self, credentials):
1351
"""Returns a clear text password for the provided credentials."""
1352
raise NotImplementedError(self.decode_password)
1354
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1356
"""Return the matching credentials from this credential store.
1358
This method is only called on fallback credential stores.
1360
raise NotImplementedError(self.get_credentials)
1364
class PlainTextCredentialStore(CredentialStore):
1365
"""Plain text credential store for the authentication.conf file."""
1367
def decode_password(self, credentials):
1368
"""See CredentialStore.decode_password."""
1369
return credentials['password']
1372
credential_store_registry.register('plain', PlainTextCredentialStore,
1373
help=PlainTextCredentialStore.__doc__)
1374
credential_store_registry.default_key = 'plain'
1377
class BzrDirConfig(object):
1379
def __init__(self, bzrdir):
1380
self._bzrdir = bzrdir
1381
self._config = bzrdir._get_config()
1383
def set_default_stack_on(self, value):
1384
"""Set the default stacking location.
1386
It may be set to a location, or None.
1388
This policy affects all branches contained by this bzrdir, except for
1389
those under repositories.
1391
if self._config is None:
1392
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1394
self._config.set_option('', 'default_stack_on')
1396
self._config.set_option(value, 'default_stack_on')
1398
def get_default_stack_on(self):
1399
"""Return the default stacking location.
1401
This will either be a location, or None.
1403
This policy affects all branches contained by this bzrdir, except for
1404
those under repositories.
1406
if self._config is None:
1408
value = self._config.get_option('default_stack_on')
1414
class TransportConfig(object):
1415
"""A Config that reads/writes a config file on a Transport.
1417
It is a low-level object that considers config data to be name/value pairs
1418
that may be associated with a section. Assigning meaning to the these
1419
values is done at higher levels like TreeConfig.
1422
def __init__(self, transport, filename):
1423
self._transport = transport
1424
self._filename = filename
1426
def get_option(self, name, section=None, default=None):
1427
"""Return the value associated with a named option.
1429
:param name: The name of the value
1430
:param section: The section the option is in (if any)
1431
:param default: The value to return if the value is not set
1432
:return: The value or default value
1434
configobj = self._get_configobj()
1436
section_obj = configobj
1439
section_obj = configobj[section]
1442
return section_obj.get(name, default)
1444
def set_option(self, value, name, section=None):
1445
"""Set the value associated with a named option.
1447
:param value: The value to set
1448
:param name: The name of the value to set
1449
:param section: The section the option is in (if any)
1451
configobj = self._get_configobj()
1453
configobj[name] = value
1455
configobj.setdefault(section, {})[name] = value
1456
self._set_configobj(configobj)
1458
def _get_config_file(self):
1460
return self._transport.get(self._filename)
1461
except errors.NoSuchFile:
1464
def _get_configobj(self):
1465
return ConfigObj(self._get_config_file(), encoding='utf-8')
1467
def _set_configobj(self, configobj):
1468
out_file = StringIO()
1469
configobj.write(out_file)
1471
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
