775
863
return osutils.pathjoin(config_dir(), 'locations.conf')
866
def authentication_config_filename():
867
"""Return per-user authentication ini file filename."""
868
return osutils.pathjoin(config_dir(), 'authentication.conf')
778
871
def user_ignore_config_filename():
779
872
"""Return the user default ignore filename"""
780
873
return osutils.pathjoin(config_dir(), 'ignore')
784
"""Calculate automatic user identification.
786
Returns (realname, email).
788
Only used when none is set in the environment or the id file.
790
This previously used the FQDN as the default domain, but that can
791
be very slow on machines where DNS is broken. So now we simply
877
"""Return the directory name to store crash files.
879
This doesn't implicitly create it.
881
On Windows it's in the config directory; elsewhere it's /var/crash
882
which may be monitored by apport. It can be overridden by
796
885
if sys.platform == 'win32':
797
name = win32utils.get_user_name_unicode()
799
raise errors.BzrError("Cannot autodetect user name.\n"
800
"Please, set your name with command like:\n"
801
'bzr whoami "Your Name <name@domain.com>"')
802
host = win32utils.get_host_name_unicode()
804
host = socket.gethostname()
805
return name, (name + '@' + host)
810
w = pwd.getpwuid(uid)
812
# we try utf-8 first, because on many variants (like Linux),
813
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
814
# false positives. (many users will have their user encoding set to
815
# latin-1, which cannot raise UnicodeError.)
817
gecos = w.pw_gecos.decode('utf-8')
821
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
822
encoding = bzrlib.user_encoding
824
raise errors.BzrCommandError('Unable to determine your name. '
825
'Use "bzr whoami" to set it.')
827
username = w.pw_name.decode(encoding)
829
raise errors.BzrCommandError('Unable to determine your name. '
830
'Use "bzr whoami" to set it.')
832
comma = gecos.find(',')
836
realname = gecos[:comma]
843
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
844
except UnicodeDecodeError:
845
raise errors.BzrError("Can't decode username as %s." % \
846
bzrlib.user_encoding)
848
return realname, (username + '@' + socket.gethostname())
886
return osutils.pathjoin(config_dir(), 'Crash')
888
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
890
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
894
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
895
# Possibly this should be different on Windows?
896
e = os.environ.get('XDG_CACHE_DIR', None)
900
return os.path.expanduser('~/.cache')
903
def parse_username(username):
904
"""Parse e-mail username and return a (name, address) tuple."""
905
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
907
return (username, '')
909
return (match.group(1), match.group(2))
851
912
def extract_email_address(e):
852
913
"""Return just the address part of an email string.
854
That is just the user@domain part, nothing else.
915
That is just the user@domain part, nothing else.
855
916
This part is required to contain only ascii characters.
856
917
If it can't be extracted, raises an error.
858
919
>>> extract_email_address('Jane Tester <jane@test.com>')
861
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
922
name, email = parse_username(e)
863
924
raise errors.NoEmailInUsername(e)
867
928
class TreeConfig(IniBasedConfig):
868
929
"""Branch configuration data associated with its contents, not location"""
931
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
869
933
def __init__(self, branch):
934
self._config = branch._get_config()
870
935
self.branch = branch
872
937
def _get_parser(self, file=None):
873
938
if file is not None:
874
939
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')
940
return self._config._get_configobj()
885
942
def get_option(self, name, section=None, default=None):
886
943
self.branch.lock_read()
888
obj = self._get_config()
890
if section is not None:
945
return self._config.get_option(name, section, default)
896
947
self.branch.unlock()
899
949
def set_option(self, value, name, section=None):
900
950
"""Set a per-branch configuration option"""
901
951
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)
953
self._config.set_option(value, name, section)
918
955
self.branch.unlock()
958
class AuthenticationConfig(object):
959
"""The authentication configuration file based on a ini file.
961
Implements the authentication.conf file described in
962
doc/developers/authentication-ring.txt.
965
def __init__(self, _file=None):
966
self._config = None # The ConfigObj
968
self._filename = authentication_config_filename()
969
self._input = self._filename = authentication_config_filename()
971
# Tests can provide a string as _file
972
self._filename = None
975
def _get_config(self):
976
if self._config is not None:
979
# FIXME: Should we validate something here ? Includes: empty
980
# sections are useless, at least one of
981
# user/password/password_encoding should be defined, etc.
983
# Note: the encoding below declares that the file itself is utf-8
984
# encoded, but the values in the ConfigObj are always Unicode.
985
self._config = ConfigObj(self._input, encoding='utf-8')
986
except configobj.ConfigObjError, e:
987
raise errors.ParseConfigError(e.errors, e.config.filename)
991
"""Save the config file, only tests should use it for now."""
992
conf_dir = os.path.dirname(self._filename)
993
ensure_config_dir_exists(conf_dir)
994
f = file(self._filename, 'wb')
996
self._get_config().write(f)
1000
def _set_option(self, section_name, option_name, value):
1001
"""Set an authentication configuration option"""
1002
conf = self._get_config()
1003
section = conf.get(section_name)
1006
section = conf[section]
1007
section[option_name] = value
1010
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1012
"""Returns the matching credentials from authentication.conf file.
1014
:param scheme: protocol
1016
:param host: the server address
1018
:param port: the associated port (optional)
1020
:param user: login (optional)
1022
:param path: the absolute path on the server (optional)
1024
:param realm: the http authentication realm (optional)
1026
:return: A dict containing the matching credentials or None.
1028
- name: the section name of the credentials in the
1029
authentication.conf file,
1030
- user: can't be different from the provided user if any,
1031
- scheme: the server protocol,
1032
- host: the server address,
1033
- port: the server port (can be None),
1034
- path: the absolute server path (can be None),
1035
- realm: the http specific authentication realm (can be None),
1036
- password: the decoded password, could be None if the credential
1037
defines only the user
1038
- verify_certificates: https specific, True if the server
1039
certificate should be verified, False otherwise.
1042
for auth_def_name, auth_def in self._get_config().items():
1043
if type(auth_def) is not configobj.Section:
1044
raise ValueError("%s defined outside a section" % auth_def_name)
1046
a_scheme, a_host, a_user, a_path = map(
1047
auth_def.get, ['scheme', 'host', 'user', 'path'])
1050
a_port = auth_def.as_int('port')
1054
raise ValueError("'port' not numeric in %s" % auth_def_name)
1056
a_verify_certificates = auth_def.as_bool('verify_certificates')
1058
a_verify_certificates = True
1061
"'verify_certificates' not boolean in %s" % auth_def_name)
1064
if a_scheme is not None and scheme != a_scheme:
1066
if a_host is not None:
1067
if not (host == a_host
1068
or (a_host.startswith('.') and host.endswith(a_host))):
1070
if a_port is not None and port != a_port:
1072
if (a_path is not None and path is not None
1073
and not path.startswith(a_path)):
1075
if (a_user is not None and user is not None
1076
and a_user != user):
1077
# Never contradict the caller about the user to be used
1082
# Prepare a credentials dictionary with additional keys
1083
# for the credential providers
1084
credentials = dict(name=auth_def_name,
1091
password=auth_def.get('password', None),
1092
verify_certificates=a_verify_certificates)
1093
# Decode the password in the credentials (or get one)
1094
self.decode_password(credentials,
1095
auth_def.get('password_encoding', None))
1096
if 'auth' in debug.debug_flags:
1097
trace.mutter("Using authentication section: %r", auth_def_name)
1100
if credentials is None:
1101
# No credentials were found in authentication.conf, try the fallback
1102
# credentials stores.
1103
credentials = credential_store_registry.get_fallback_credentials(
1104
scheme, host, port, user, path, realm)
1108
def set_credentials(self, name, host, user, scheme=None, password=None,
1109
port=None, path=None, verify_certificates=None,
1111
"""Set authentication credentials for a host.
1113
Any existing credentials with matching scheme, host, port and path
1114
will be deleted, regardless of name.
1116
:param name: An arbitrary name to describe this set of credentials.
1117
:param host: Name of the host that accepts these credentials.
1118
:param user: The username portion of these credentials.
1119
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1121
:param password: Password portion of these credentials.
1122
:param port: The IP port on the host that these credentials apply to.
1123
:param path: A filesystem path on the host that these credentials
1125
:param verify_certificates: On https, verify server certificates if
1127
:param realm: The http authentication realm (optional).
1129
values = {'host': host, 'user': user}
1130
if password is not None:
1131
values['password'] = password
1132
if scheme is not None:
1133
values['scheme'] = scheme
1134
if port is not None:
1135
values['port'] = '%d' % port
1136
if path is not None:
1137
values['path'] = path
1138
if verify_certificates is not None:
1139
values['verify_certificates'] = str(verify_certificates)
1140
if realm is not None:
1141
values['realm'] = realm
1142
config = self._get_config()
1144
for section, existing_values in config.items():
1145
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1146
if existing_values.get(key) != values.get(key):
1150
config.update({name: values})
1153
def get_user(self, scheme, host, port=None, realm=None, path=None,
1154
prompt=None, ask=False, default=None):
1155
"""Get a user from authentication file.
1157
:param scheme: protocol
1159
:param host: the server address
1161
:param port: the associated port (optional)
1163
:param realm: the realm sent by the server (optional)
1165
:param path: the absolute path on the server (optional)
1167
:param ask: Ask the user if there is no explicitly configured username
1170
:param default: The username returned if none is defined (optional).
1172
:return: The found user.
1174
credentials = self.get_credentials(scheme, host, port, user=None,
1175
path=path, realm=realm)
1176
if credentials is not None:
1177
user = credentials['user']
1183
# Create a default prompt suitable for most cases
1184
prompt = scheme.upper() + ' %(host)s username'
1185
# Special handling for optional fields in the prompt
1186
if port is not None:
1187
prompt_host = '%s:%d' % (host, port)
1190
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1195
def get_password(self, scheme, host, user, port=None,
1196
realm=None, path=None, prompt=None):
1197
"""Get a password from authentication file or prompt the user for one.
1199
:param scheme: protocol
1201
:param host: the server address
1203
:param port: the associated port (optional)
1207
:param realm: the realm sent by the server (optional)
1209
:param path: the absolute path on the server (optional)
1211
:return: The found password or the one entered by the user.
1213
credentials = self.get_credentials(scheme, host, port, user, path,
1215
if credentials is not None:
1216
password = credentials['password']
1217
if password is not None and scheme is 'ssh':
1218
trace.warning('password ignored in section [%s],'
1219
' use an ssh agent instead'
1220
% credentials['name'])
1224
# Prompt user only if we could't find a password
1225
if password is None:
1227
# Create a default prompt suitable for most cases
1228
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1229
# Special handling for optional fields in the prompt
1230
if port is not None:
1231
prompt_host = '%s:%d' % (host, port)
1234
password = ui.ui_factory.get_password(prompt,
1235
host=prompt_host, user=user)
1238
def decode_password(self, credentials, encoding):
1240
cs = credential_store_registry.get_credential_store(encoding)
1242
raise ValueError('%r is not a known password_encoding' % encoding)
1243
credentials['password'] = cs.decode_password(credentials)
1247
class CredentialStoreRegistry(registry.Registry):
1248
"""A class that registers credential stores.
1250
A credential store provides access to credentials via the password_encoding
1251
field in authentication.conf sections.
1253
Except for stores provided by bzr itself, most stores are expected to be
1254
provided by plugins that will therefore use
1255
register_lazy(password_encoding, module_name, member_name, help=help,
1256
fallback=fallback) to install themselves.
1258
A fallback credential store is one that is queried if no credentials can be
1259
found via authentication.conf.
1262
def get_credential_store(self, encoding=None):
1263
cs = self.get(encoding)
1268
def is_fallback(self, name):
1269
"""Check if the named credentials store should be used as fallback."""
1270
return self.get_info(name)
1272
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1273
path=None, realm=None):
1274
"""Request credentials from all fallback credentials stores.
1276
The first credentials store that can provide credentials wins.
1279
for name in self.keys():
1280
if not self.is_fallback(name):
1282
cs = self.get_credential_store(name)
1283
credentials = cs.get_credentials(scheme, host, port, user,
1285
if credentials is not None:
1286
# We found some credentials
1290
def register(self, key, obj, help=None, override_existing=False,
1292
"""Register a new object to a name.
1294
:param key: This is the key to use to request the object later.
1295
:param obj: The object to register.
1296
:param help: Help text for this entry. This may be a string or
1297
a callable. If it is a callable, it should take two
1298
parameters (registry, key): this registry and the key that
1299
the help was registered under.
1300
:param override_existing: Raise KeyErorr if False and something has
1301
already been registered for that key. If True, ignore if there
1302
is an existing key (always register the new value).
1303
:param fallback: Whether this credential store should be
1306
return super(CredentialStoreRegistry,
1307
self).register(key, obj, help, info=fallback,
1308
override_existing=override_existing)
1310
def register_lazy(self, key, module_name, member_name,
1311
help=None, override_existing=False,
1313
"""Register a new credential store to be loaded on request.
1315
:param module_name: The python path to the module. Such as 'os.path'.
1316
:param member_name: The member of the module to return. If empty or
1317
None, get() will return the module itself.
1318
:param help: Help text for this entry. This may be a string or
1320
:param override_existing: If True, replace the existing object
1321
with the new one. If False, if there is already something
1322
registered with the same key, raise a KeyError
1323
:param fallback: Whether this credential store should be
1326
return super(CredentialStoreRegistry, self).register_lazy(
1327
key, module_name, member_name, help,
1328
info=fallback, override_existing=override_existing)
1331
credential_store_registry = CredentialStoreRegistry()
1334
class CredentialStore(object):
1335
"""An abstract class to implement storage for credentials"""
1337
def decode_password(self, credentials):
1338
"""Returns a clear text password for the provided credentials."""
1339
raise NotImplementedError(self.decode_password)
1341
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1343
"""Return the matching credentials from this credential store.
1345
This method is only called on fallback credential stores.
1347
raise NotImplementedError(self.get_credentials)
1351
class PlainTextCredentialStore(CredentialStore):
1352
__doc__ = """Plain text credential store for the authentication.conf file"""
1354
def decode_password(self, credentials):
1355
"""See CredentialStore.decode_password."""
1356
return credentials['password']
1359
credential_store_registry.register('plain', PlainTextCredentialStore,
1360
help=PlainTextCredentialStore.__doc__)
1361
credential_store_registry.default_key = 'plain'
1364
class BzrDirConfig(object):
1366
def __init__(self, bzrdir):
1367
self._bzrdir = bzrdir
1368
self._config = bzrdir._get_config()
1370
def set_default_stack_on(self, value):
1371
"""Set the default stacking location.
1373
It may be set to a location, or None.
1375
This policy affects all branches contained by this bzrdir, except for
1376
those under repositories.
1378
if self._config is None:
1379
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1381
self._config.set_option('', 'default_stack_on')
1383
self._config.set_option(value, 'default_stack_on')
1385
def get_default_stack_on(self):
1386
"""Return the default stacking location.
1388
This will either be a location, or None.
1390
This policy affects all branches contained by this bzrdir, except for
1391
those under repositories.
1393
if self._config is None:
1395
value = self._config.get_option('default_stack_on')
1401
class TransportConfig(object):
1402
"""A Config that reads/writes a config file on a Transport.
1404
It is a low-level object that considers config data to be name/value pairs
1405
that may be associated with a section. Assigning meaning to the these
1406
values is done at higher levels like TreeConfig.
1409
def __init__(self, transport, filename):
1410
self._transport = transport
1411
self._filename = filename
1413
def get_option(self, name, section=None, default=None):
1414
"""Return the value associated with a named option.
1416
:param name: The name of the value
1417
:param section: The section the option is in (if any)
1418
:param default: The value to return if the value is not set
1419
:return: The value or default value
1421
configobj = self._get_configobj()
1423
section_obj = configobj
1426
section_obj = configobj[section]
1429
return section_obj.get(name, default)
1431
def set_option(self, value, name, section=None):
1432
"""Set the value associated with a named option.
1434
:param value: The value to set
1435
:param name: The name of the value to set
1436
:param section: The section the option is in (if any)
1438
configobj = self._get_configobj()
1440
configobj[name] = value
1442
configobj.setdefault(section, {})[name] = value
1443
self._set_configobj(configobj)
1445
def _get_config_file(self):
1447
return StringIO(self._transport.get_bytes(self._filename))
1448
except errors.NoSuchFile:
1451
def _get_configobj(self):
1452
f = self._get_config_file()
1454
return ConfigObj(f, encoding='utf-8')
1458
def _set_configobj(self, configobj):
1459
out_file = StringIO()
1460
configobj.write(out_file)
1462
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
