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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
# -*- coding: utf-8 -*-
# providerconfig.py
# Copyright (C) 2013 LEAP
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
Provider configuration
"""
import logging
import os
from leap.bitmask import provider
from leap.bitmask.config.provider_spec import leap_provider_spec
from leap.bitmask.services import get_service_display_name
from leap.bitmask.util import get_path_prefix
from leap.common.check import leap_check
from leap.common.config.baseconfig import BaseConfig, LocalizedKey
logger = logging.getLogger(__name__)
class MissingCACert(Exception):
"""
Raised when a CA certificate is needed but not found.
"""
pass
class ProviderConfig(BaseConfig):
"""
Provider configuration abstraction class
"""
def __init__(self):
BaseConfig.__init__(self)
@classmethod
def get_provider_config(self, domain):
"""
Helper to return a valid Provider Config from the domain name.
:param domain: the domain name of the provider.
:type domain: str
:rtype: ProviderConfig or None if there is a problem loading the config
"""
provider_config = ProviderConfig()
if not provider_config.load(provider.get_provider_path(domain)):
provider_config = None
return provider_config
def _get_schema(self):
"""
Returns the schema corresponding to the version given.
:rtype: dict or None if the version is not supported.
"""
return leap_provider_spec
def _get_spec(self):
"""
Returns the spec object for the specific configuration.
Override the BaseConfig one because we do not support multiple schemas
for the provider yet.
:rtype: dict or None if the version is not supported.
"""
return self._get_schema()
def get_api_uri(self):
return self._safe_get_value("api_uri")
def get_api_version(self):
return self._safe_get_value("api_version")
def get_ca_cert_fingerprint(self):
return self._safe_get_value("ca_cert_fingerprint")
def get_ca_cert_uri(self):
return self._safe_get_value("ca_cert_uri")
def get_default_language(self):
return self._safe_get_value("default_language")
@LocalizedKey
def get_description(self):
return self._safe_get_value("description")
@classmethod
def sanitize_path_component(cls, component):
"""
If the provider tries to instrument the component of a path
that is controlled by them, this will take care of
removing/escaping all the necessary elements.
:param component: Path component to process
:type component: unicode or str
:returns: The path component properly escaped
:rtype: unicode or str
"""
# TODO: Fix for windows, names like "aux" or "con" aren't
# allowed.
return component.replace(os.path.sep, "")
def get_domain(self):
return ProviderConfig.sanitize_path_component(
self._safe_get_value("domain"))
def get_enrollment_policy(self):
"""
Returns the enrollment policy
:rtype: string
"""
return self._safe_get_value("enrollment_policy")
def get_languages(self):
return self._safe_get_value("languages")
@LocalizedKey
def get_name(self):
return self._safe_get_value("name")
def get_services(self):
"""
Returns a list with the available services in the current provider.
:rtype: list
"""
services = self._safe_get_value("services")
return services
def get_services_string(self):
"""
Returns a string with the available services in the current
provider, ready to be shown to the user.
"""
services = []
for service in self.get_services():
services.append(get_service_display_name(service))
services_str = ", ".join(services)
return services_str
def get_ca_cert_path(self, about_to_download=False):
"""
Returns the path to the certificate for the current provider.
It may raise MissingCACert if
the certificate does not exists and not about_to_download
:param about_to_download: defines wether we want the path to
download the cert or not. This helps avoid
checking if the cert exists because we
are about to write it.
:type about_to_download: bool
:rtype: unicode
"""
cert_path = os.path.join(get_path_prefix(), "leap", "providers",
self.get_domain(), "keys", "ca", "cacert.pem")
if not about_to_download:
cert_exists = os.path.exists(cert_path)
error_msg = "You need to download the certificate first"
leap_check(cert_exists, error_msg, MissingCACert)
logger.debug("Going to verify SSL against %s" % (cert_path,))
return cert_path
def provides_eip(self):
"""
Returns True if this particular provider has the EIP service,
False otherwise.
:rtype: bool
"""
return "openvpn" in self.get_services()
def provides_mx(self):
"""
Returns True if this particular provider has the MX service,
False otherwise.
:rtype: bool
"""
return "mx" in self.get_services()
|
