885
804
except ImportError:
888
user_encoding = osutils.get_user_encoding()
889
realname = username = getpass.getuser().decode(user_encoding)
807
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
890
808
except UnicodeDecodeError:
891
809
raise errors.BzrError("Can't decode username as %s." % \
810
bzrlib.user_encoding)
894
812
return realname, (username + '@' + socket.gethostname())
897
def parse_username(username):
898
"""Parse e-mail username and return a (name, address) tuple."""
899
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
901
return (username, '')
903
return (match.group(1), match.group(2))
906
815
def extract_email_address(e):
907
816
"""Return just the address part of an email string.
909
That is just the user@domain part, nothing else.
818
That is just the user@domain part, nothing else.
910
819
This part is required to contain only ascii characters.
911
820
If it can't be extracted, raises an error.
913
822
>>> extract_email_address('Jane Tester <jane@test.com>')
916
name, email = parse_username(e)
825
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
918
827
raise errors.NoEmailInUsername(e)
922
831
class TreeConfig(IniBasedConfig):
923
832
"""Branch configuration data associated with its contents, not location"""
925
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
927
833
def __init__(self, branch):
928
self._config = branch._get_config()
929
834
self.branch = branch
931
836
def _get_parser(self, file=None):
932
837
if file is not None:
933
838
return IniBasedConfig._get_parser(file)
934
return self._config._get_configobj()
839
return self._get_config()
841
def _get_config(self):
843
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
845
except errors.NoSuchFile:
846
obj = ConfigObj(encoding='utf=8')
936
849
def get_option(self, name, section=None, default=None):
937
850
self.branch.lock_read()
939
return self._config.get_option(name, section, default)
852
obj = self._get_config()
854
if section is not None:
941
860
self.branch.unlock()
943
863
def set_option(self, value, name, section=None):
944
864
"""Set a per-branch configuration option"""
945
865
self.branch.lock_write()
947
self._config.set_option(value, name, section)
867
cfg_obj = self._get_config()
872
obj = cfg_obj[section]
874
cfg_obj[section] = {}
875
obj = cfg_obj[section]
877
out_file = StringIO()
878
cfg_obj.write(out_file)
880
self.branch.control_files.put('branch.conf', out_file)
949
882
self.branch.unlock()
952
class AuthenticationConfig(object):
953
"""The authentication configuration file based on a ini file.
955
Implements the authentication.conf file described in
956
doc/developers/authentication-ring.txt.
959
def __init__(self, _file=None):
960
self._config = None # The ConfigObj
962
self._filename = authentication_config_filename()
963
self._input = self._filename = authentication_config_filename()
965
# Tests can provide a string as _file
966
self._filename = None
969
def _get_config(self):
970
if self._config is not None:
973
# FIXME: Should we validate something here ? Includes: empty
974
# sections are useless, at least one of
975
# user/password/password_encoding should be defined, etc.
977
# Note: the encoding below declares that the file itself is utf-8
978
# encoded, but the values in the ConfigObj are always Unicode.
979
self._config = ConfigObj(self._input, encoding='utf-8')
980
except configobj.ConfigObjError, e:
981
raise errors.ParseConfigError(e.errors, e.config.filename)
985
"""Save the config file, only tests should use it for now."""
986
conf_dir = os.path.dirname(self._filename)
987
ensure_config_dir_exists(conf_dir)
988
self._get_config().write(file(self._filename, 'wb'))
990
def _set_option(self, section_name, option_name, value):
991
"""Set an authentication configuration option"""
992
conf = self._get_config()
993
section = conf.get(section_name)
996
section = conf[section]
997
section[option_name] = value
1000
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1002
"""Returns the matching credentials from authentication.conf file.
1004
:param scheme: protocol
1006
:param host: the server address
1008
:param port: the associated port (optional)
1010
:param user: login (optional)
1012
:param path: the absolute path on the server (optional)
1014
:param realm: the http authentication realm (optional)
1016
:return: A dict containing the matching credentials or None.
1018
- name: the section name of the credentials in the
1019
authentication.conf file,
1020
- user: can't be different from the provided user if any,
1021
- scheme: the server protocol,
1022
- host: the server address,
1023
- port: the server port (can be None),
1024
- path: the absolute server path (can be None),
1025
- realm: the http specific authentication realm (can be None),
1026
- password: the decoded password, could be None if the credential
1027
defines only the user
1028
- verify_certificates: https specific, True if the server
1029
certificate should be verified, False otherwise.
1032
for auth_def_name, auth_def in self._get_config().items():
1033
if type(auth_def) is not configobj.Section:
1034
raise ValueError("%s defined outside a section" % auth_def_name)
1036
a_scheme, a_host, a_user, a_path = map(
1037
auth_def.get, ['scheme', 'host', 'user', 'path'])
1040
a_port = auth_def.as_int('port')
1044
raise ValueError("'port' not numeric in %s" % auth_def_name)
1046
a_verify_certificates = auth_def.as_bool('verify_certificates')
1048
a_verify_certificates = True
1051
"'verify_certificates' not boolean in %s" % auth_def_name)
1054
if a_scheme is not None and scheme != a_scheme:
1056
if a_host is not None:
1057
if not (host == a_host
1058
or (a_host.startswith('.') and host.endswith(a_host))):
1060
if a_port is not None and port != a_port:
1062
if (a_path is not None and path is not None
1063
and not path.startswith(a_path)):
1065
if (a_user is not None and user is not None
1066
and a_user != user):
1067
# Never contradict the caller about the user to be used
1072
# Prepare a credentials dictionary with additional keys
1073
# for the credential providers
1074
credentials = dict(name=auth_def_name,
1081
password=auth_def.get('password', None),
1082
verify_certificates=a_verify_certificates)
1083
# Decode the password in the credentials (or get one)
1084
self.decode_password(credentials,
1085
auth_def.get('password_encoding', None))
1086
if 'auth' in debug.debug_flags:
1087
trace.mutter("Using authentication section: %r", auth_def_name)
1090
if credentials is None:
1091
# No credentials were found in authentication.conf, try the fallback
1092
# credentials stores.
1093
credentials = credential_store_registry.get_fallback_credentials(
1094
scheme, host, port, user, path, realm)
1098
def set_credentials(self, name, host, user, scheme=None, password=None,
1099
port=None, path=None, verify_certificates=None,
1101
"""Set authentication credentials for a host.
1103
Any existing credentials with matching scheme, host, port and path
1104
will be deleted, regardless of name.
1106
:param name: An arbitrary name to describe this set of credentials.
1107
:param host: Name of the host that accepts these credentials.
1108
:param user: The username portion of these credentials.
1109
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1111
:param password: Password portion of these credentials.
1112
:param port: The IP port on the host that these credentials apply to.
1113
:param path: A filesystem path on the host that these credentials
1115
:param verify_certificates: On https, verify server certificates if
1117
:param realm: The http authentication realm (optional).
1119
values = {'host': host, 'user': user}
1120
if password is not None:
1121
values['password'] = password
1122
if scheme is not None:
1123
values['scheme'] = scheme
1124
if port is not None:
1125
values['port'] = '%d' % port
1126
if path is not None:
1127
values['path'] = path
1128
if verify_certificates is not None:
1129
values['verify_certificates'] = str(verify_certificates)
1130
if realm is not None:
1131
values['realm'] = realm
1132
config = self._get_config()
1134
for section, existing_values in config.items():
1135
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1136
if existing_values.get(key) != values.get(key):
1140
config.update({name: values})
1143
def get_user(self, scheme, host, port=None, realm=None, path=None,
1144
prompt=None, ask=False, default=None):
1145
"""Get a user from authentication file.
1147
:param scheme: protocol
1149
:param host: the server address
1151
:param port: the associated port (optional)
1153
:param realm: the realm sent by the server (optional)
1155
:param path: the absolute path on the server (optional)
1157
:param ask: Ask the user if there is no explicitly configured username
1160
:param default: The username returned if none is defined (optional).
1162
:return: The found user.
1164
credentials = self.get_credentials(scheme, host, port, user=None,
1165
path=path, realm=realm)
1166
if credentials is not None:
1167
user = credentials['user']
1173
# Create a default prompt suitable for most cases
1174
prompt = scheme.upper() + ' %(host)s username'
1175
# Special handling for optional fields in the prompt
1176
if port is not None:
1177
prompt_host = '%s:%d' % (host, port)
1180
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1185
def get_password(self, scheme, host, user, port=None,
1186
realm=None, path=None, prompt=None):
1187
"""Get a password from authentication file or prompt the user for one.
1189
:param scheme: protocol
1191
:param host: the server address
1193
:param port: the associated port (optional)
1197
:param realm: the realm sent by the server (optional)
1199
:param path: the absolute path on the server (optional)
1201
:return: The found password or the one entered by the user.
1203
credentials = self.get_credentials(scheme, host, port, user, path,
1205
if credentials is not None:
1206
password = credentials['password']
1207
if password is not None and scheme is 'ssh':
1208
trace.warning('password ignored in section [%s],'
1209
' use an ssh agent instead'
1210
% credentials['name'])
1214
# Prompt user only if we could't find a password
1215
if password is None:
1217
# Create a default prompt suitable for most cases
1218
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1219
# Special handling for optional fields in the prompt
1220
if port is not None:
1221
prompt_host = '%s:%d' % (host, port)
1224
password = ui.ui_factory.get_password(prompt,
1225
host=prompt_host, user=user)
1228
def decode_password(self, credentials, encoding):
1230
cs = credential_store_registry.get_credential_store(encoding)
1232
raise ValueError('%r is not a known password_encoding' % encoding)
1233
credentials['password'] = cs.decode_password(credentials)
1237
class CredentialStoreRegistry(registry.Registry):
1238
"""A class that registers credential stores.
1240
A credential store provides access to credentials via the password_encoding
1241
field in authentication.conf sections.
1243
Except for stores provided by bzr itself, most stores are expected to be
1244
provided by plugins that will therefore use
1245
register_lazy(password_encoding, module_name, member_name, help=help,
1246
fallback=fallback) to install themselves.
1248
A fallback credential store is one that is queried if no credentials can be
1249
found via authentication.conf.
1252
def get_credential_store(self, encoding=None):
1253
cs = self.get(encoding)
1258
def is_fallback(self, name):
1259
"""Check if the named credentials store should be used as fallback."""
1260
return self.get_info(name)
1262
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1263
path=None, realm=None):
1264
"""Request credentials from all fallback credentials stores.
1266
The first credentials store that can provide credentials wins.
1269
for name in self.keys():
1270
if not self.is_fallback(name):
1272
cs = self.get_credential_store(name)
1273
credentials = cs.get_credentials(scheme, host, port, user,
1275
if credentials is not None:
1276
# We found some credentials
1280
def register(self, key, obj, help=None, override_existing=False,
1282
"""Register a new object to a name.
1284
:param key: This is the key to use to request the object later.
1285
:param obj: The object to register.
1286
:param help: Help text for this entry. This may be a string or
1287
a callable. If it is a callable, it should take two
1288
parameters (registry, key): this registry and the key that
1289
the help was registered under.
1290
:param override_existing: Raise KeyErorr if False and something has
1291
already been registered for that key. If True, ignore if there
1292
is an existing key (always register the new value).
1293
:param fallback: Whether this credential store should be
1296
return super(CredentialStoreRegistry,
1297
self).register(key, obj, help, info=fallback,
1298
override_existing=override_existing)
1300
def register_lazy(self, key, module_name, member_name,
1301
help=None, override_existing=False,
1303
"""Register a new credential store to be loaded on request.
1305
:param module_name: The python path to the module. Such as 'os.path'.
1306
:param member_name: The member of the module to return. If empty or
1307
None, get() will return the module itself.
1308
:param help: Help text for this entry. This may be a string or
1310
:param override_existing: If True, replace the existing object
1311
with the new one. If False, if there is already something
1312
registered with the same key, raise a KeyError
1313
:param fallback: Whether this credential store should be
1316
return super(CredentialStoreRegistry, self).register_lazy(
1317
key, module_name, member_name, help,
1318
info=fallback, override_existing=override_existing)
1321
credential_store_registry = CredentialStoreRegistry()
1324
class CredentialStore(object):
1325
"""An abstract class to implement storage for credentials"""
1327
def decode_password(self, credentials):
1328
"""Returns a clear text password for the provided credentials."""
1329
raise NotImplementedError(self.decode_password)
1331
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1333
"""Return the matching credentials from this credential store.
1335
This method is only called on fallback credential stores.
1337
raise NotImplementedError(self.get_credentials)
1341
class PlainTextCredentialStore(CredentialStore):
1342
"""Plain text credential store for the authentication.conf file."""
1344
def decode_password(self, credentials):
1345
"""See CredentialStore.decode_password."""
1346
return credentials['password']
1349
credential_store_registry.register('plain', PlainTextCredentialStore,
1350
help=PlainTextCredentialStore.__doc__)
1351
credential_store_registry.default_key = 'plain'
1354
class BzrDirConfig(object):
1356
def __init__(self, bzrdir):
1357
self._bzrdir = bzrdir
1358
self._config = bzrdir._get_config()
1360
def set_default_stack_on(self, value):
1361
"""Set the default stacking location.
1363
It may be set to a location, or None.
1365
This policy affects all branches contained by this bzrdir, except for
1366
those under repositories.
1368
if self._config is None:
1369
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1371
self._config.set_option('', 'default_stack_on')
1373
self._config.set_option(value, 'default_stack_on')
1375
def get_default_stack_on(self):
1376
"""Return the default stacking location.
1378
This will either be a location, or None.
1380
This policy affects all branches contained by this bzrdir, except for
1381
those under repositories.
1383
if self._config is None:
1385
value = self._config.get_option('default_stack_on')
1391
class TransportConfig(object):
1392
"""A Config that reads/writes a config file on a Transport.
1394
It is a low-level object that considers config data to be name/value pairs
1395
that may be associated with a section. Assigning meaning to the these
1396
values is done at higher levels like TreeConfig.
1399
def __init__(self, transport, filename):
1400
self._transport = transport
1401
self._filename = filename
1403
def get_option(self, name, section=None, default=None):
1404
"""Return the value associated with a named option.
1406
:param name: The name of the value
1407
:param section: The section the option is in (if any)
1408
:param default: The value to return if the value is not set
1409
:return: The value or default value
1411
configobj = self._get_configobj()
1413
section_obj = configobj
1416
section_obj = configobj[section]
1419
return section_obj.get(name, default)
1421
def set_option(self, value, name, section=None):
1422
"""Set the value associated with a named option.
1424
:param value: The value to set
1425
:param name: The name of the value to set
1426
:param section: The section the option is in (if any)
1428
configobj = self._get_configobj()
1430
configobj[name] = value
1432
configobj.setdefault(section, {})[name] = value
1433
self._set_configobj(configobj)
1435
def _get_config_file(self):
1437
return self._transport.get(self._filename)
1438
except errors.NoSuchFile:
1441
def _get_configobj(self):
1442
return ConfigObj(self._get_config_file(), encoding='utf-8')
1444
def _set_configobj(self, configobj):
1445
out_file = StringIO()
1446
configobj.write(out_file)
1448
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
