-
Notifications
You must be signed in to change notification settings - Fork 4.1k
/
__init__.py
986 lines (801 loc) · 30.8 KB
/
__init__.py
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
"""
Usage
-----
.. code-block:: bash
mlflow server --app-name basic-auth
"""
import functools
import importlib
import logging
import re
import uuid
from typing import Any, Callable, Dict, Optional, Union
import sqlalchemy
from flask import Flask, Response, flash, jsonify, make_response, render_template_string, request
from werkzeug.datastructures import Authorization
from mlflow import MlflowException
from mlflow.entities import Experiment
from mlflow.entities.model_registry import RegisteredModel
from mlflow.protos.databricks_pb2 import (
BAD_REQUEST,
INTERNAL_ERROR,
INVALID_PARAMETER_VALUE,
RESOURCE_DOES_NOT_EXIST,
ErrorCode,
)
from mlflow.protos.model_registry_pb2 import (
CreateModelVersion,
CreateRegisteredModel,
DeleteModelVersion,
DeleteModelVersionTag,
DeleteRegisteredModel,
DeleteRegisteredModelAlias,
DeleteRegisteredModelTag,
GetLatestVersions,
GetModelVersion,
GetModelVersionByAlias,
GetModelVersionDownloadUri,
GetRegisteredModel,
RenameRegisteredModel,
SearchRegisteredModels,
SetModelVersionTag,
SetRegisteredModelAlias,
SetRegisteredModelTag,
TransitionModelVersionStage,
UpdateModelVersion,
UpdateRegisteredModel,
)
from mlflow.protos.service_pb2 import (
CreateExperiment,
CreateRun,
DeleteExperiment,
DeleteRun,
DeleteTag,
GetExperiment,
GetExperimentByName,
GetMetricHistory,
GetRun,
ListArtifacts,
LogBatch,
LogMetric,
LogModel,
LogParam,
RestoreExperiment,
RestoreRun,
SearchExperiments,
SetExperimentTag,
SetTag,
UpdateExperiment,
UpdateRun,
)
from mlflow.server import app
from mlflow.server.auth.config import read_auth_config
from mlflow.server.auth.logo import MLFLOW_LOGO
from mlflow.server.auth.permissions import MANAGE, Permission, get_permission
from mlflow.server.auth.routes import (
CREATE_EXPERIMENT_PERMISSION,
CREATE_REGISTERED_MODEL_PERMISSION,
CREATE_USER,
DELETE_EXPERIMENT_PERMISSION,
DELETE_REGISTERED_MODEL_PERMISSION,
DELETE_USER,
GET_EXPERIMENT_PERMISSION,
GET_REGISTERED_MODEL_PERMISSION,
GET_USER,
HOME,
SIGNUP,
UPDATE_EXPERIMENT_PERMISSION,
UPDATE_REGISTERED_MODEL_PERMISSION,
UPDATE_USER_ADMIN,
UPDATE_USER_PASSWORD,
)
from mlflow.server.auth.sqlalchemy_store import SqlAlchemyStore
from mlflow.server.handlers import (
_get_model_registry_store,
_get_request_message,
_get_tracking_store,
catch_mlflow_exception,
get_endpoints,
)
from mlflow.store.entities import PagedList
from mlflow.utils.proto_json_utils import message_to_json, parse_dict
from mlflow.utils.rest_utils import _REST_API_PATH_PREFIX
from mlflow.utils.search_utils import SearchUtils
_logger = logging.getLogger(__name__)
auth_config = read_auth_config()
store = SqlAlchemyStore()
def is_unprotected_route(path: str) -> bool:
return path.startswith(("/static", "/favicon.ico", "/health"))
def make_basic_auth_response() -> Response:
res = make_response(
"You are not authenticated. Please see "
"https://www.mlflow.org/docs/latest/auth/index.html#authenticating-to-mlflow "
"on how to authenticate."
)
res.status_code = 401
res.headers["WWW-Authenticate"] = 'Basic realm="mlflow"'
return res
def make_forbidden_response() -> Response:
res = make_response("Permission denied")
res.status_code = 403
return res
def _get_request_param(param: str) -> str:
if request.method == "GET":
args = request.args
elif request.method in ("POST", "PATCH", "DELETE"):
args = request.json
else:
raise MlflowException(
f"Unsupported HTTP method '{request.method}'",
BAD_REQUEST,
)
if param not in args:
# Special handling for run_id
if param == "run_id":
return _get_request_param("run_uuid")
raise MlflowException(
f"Missing value for required parameter '{param}'. "
"See the API docs for more information about request parameters.",
INVALID_PARAMETER_VALUE,
)
return args[param]
def _get_permission_from_store_or_default(store_permission_func: Callable[[], str]) -> Permission:
"""
Attempts to get permission from store,
and returns default permission if no record is found.
"""
try:
perm = store_permission_func()
except MlflowException as e:
if e.error_code == ErrorCode.Name(RESOURCE_DOES_NOT_EXIST):
perm = auth_config.default_permission
else:
raise
return get_permission(perm)
def _get_permission_from_experiment_id() -> Permission:
experiment_id = _get_request_param("experiment_id")
username = authenticate_request().username
return _get_permission_from_store_or_default(
lambda: store.get_experiment_permission(experiment_id, username).permission
)
_EXPERIMENT_ID_PATTERN = re.compile(r"^(\d+)/")
def _get_experiment_id_from_view_args():
if artifact_path := request.view_args.get("artifact_path"):
if m := _EXPERIMENT_ID_PATTERN.match(artifact_path):
return m.group(1)
return None
def _get_permission_from_experiment_id_artifact_proxy() -> Permission:
if experiment_id := _get_experiment_id_from_view_args():
username = authenticate_request().username
return _get_permission_from_store_or_default(
lambda: store.get_experiment_permission(experiment_id, username).permission
)
return get_permission(auth_config.default_permission)
def _get_permission_from_experiment_name() -> Permission:
experiment_name = _get_request_param("experiment_name")
store_exp = _get_tracking_store().get_experiment_by_name(experiment_name)
if store_exp is None:
raise MlflowException(
f"Could not find experiment with name {experiment_name}",
error_code=RESOURCE_DOES_NOT_EXIST,
)
username = authenticate_request().username
return _get_permission_from_store_or_default(
lambda: store.get_experiment_permission(store_exp.experiment_id, username).permission
)
def _get_permission_from_run_id() -> Permission:
# run permissions inherit from parent resource (experiment)
# so we just get the experiment permission
run_id = _get_request_param("run_id")
run = _get_tracking_store().get_run(run_id)
experiment_id = run.info.experiment_id
username = authenticate_request().username
return _get_permission_from_store_or_default(
lambda: store.get_experiment_permission(experiment_id, username).permission
)
def _get_permission_from_registered_model_name() -> Permission:
name = _get_request_param("name")
username = authenticate_request().username
return _get_permission_from_store_or_default(
lambda: store.get_registered_model_permission(name, username).permission
)
def validate_can_read_experiment():
return _get_permission_from_experiment_id().can_read
def validate_can_read_experiment_by_name():
return _get_permission_from_experiment_name().can_read
def validate_can_update_experiment():
return _get_permission_from_experiment_id().can_update
def validate_can_delete_experiment():
return _get_permission_from_experiment_id().can_delete
def validate_can_manage_experiment():
return _get_permission_from_experiment_id().can_manage
def validate_can_read_experiment_artifact_proxy():
return _get_permission_from_experiment_id_artifact_proxy().can_read
def validate_can_update_experiment_artifact_proxy():
return _get_permission_from_experiment_id_artifact_proxy().can_update
def validate_can_delete_experiment_artifact_proxy():
return _get_permission_from_experiment_id_artifact_proxy().can_manage
def validate_can_read_run():
return _get_permission_from_run_id().can_read
def validate_can_update_run():
return _get_permission_from_run_id().can_update
def validate_can_delete_run():
return _get_permission_from_run_id().can_delete
def validate_can_manage_run():
return _get_permission_from_run_id().can_manage
def validate_can_read_registered_model():
return _get_permission_from_registered_model_name().can_read
def validate_can_update_registered_model():
return _get_permission_from_registered_model_name().can_update
def validate_can_delete_registered_model():
return _get_permission_from_registered_model_name().can_delete
def validate_can_manage_registered_model():
return _get_permission_from_registered_model_name().can_manage
def sender_is_admin():
"""Validate if the sender is admin"""
username = authenticate_request().username
return store.get_user(username).is_admin
def username_is_sender():
"""Validate if the request username is the sender"""
username = _get_request_param("username")
sender = authenticate_request().username
return username == sender
def validate_can_read_user():
return username_is_sender()
def validate_can_create_user():
# only admins can create user, but admins won't reach this validator
return False
def validate_can_update_user_password():
return username_is_sender()
def validate_can_update_user_admin():
# only admins can update, but admins won't reach this validator
return False
def validate_can_delete_user():
# only admins can delete, but admins won't reach this validator
return False
BEFORE_REQUEST_HANDLERS = {
# Routes for experiments
GetExperiment: validate_can_read_experiment,
GetExperimentByName: validate_can_read_experiment_by_name,
DeleteExperiment: validate_can_delete_experiment,
RestoreExperiment: validate_can_delete_experiment,
UpdateExperiment: validate_can_update_experiment,
SetExperimentTag: validate_can_update_experiment,
# Routes for runs
CreateRun: validate_can_update_experiment,
GetRun: validate_can_read_run,
DeleteRun: validate_can_delete_run,
RestoreRun: validate_can_delete_run,
UpdateRun: validate_can_update_run,
LogMetric: validate_can_update_run,
LogBatch: validate_can_update_run,
LogModel: validate_can_update_run,
SetTag: validate_can_update_run,
DeleteTag: validate_can_update_run,
LogParam: validate_can_update_run,
GetMetricHistory: validate_can_read_run,
ListArtifacts: validate_can_read_run,
# Routes for model registry
GetRegisteredModel: validate_can_read_registered_model,
DeleteRegisteredModel: validate_can_delete_registered_model,
UpdateRegisteredModel: validate_can_update_registered_model,
RenameRegisteredModel: validate_can_update_registered_model,
GetLatestVersions: validate_can_read_registered_model,
CreateModelVersion: validate_can_update_registered_model,
GetModelVersion: validate_can_read_registered_model,
DeleteModelVersion: validate_can_delete_registered_model,
UpdateModelVersion: validate_can_update_registered_model,
TransitionModelVersionStage: validate_can_update_registered_model,
GetModelVersionDownloadUri: validate_can_read_registered_model,
SetRegisteredModelTag: validate_can_update_registered_model,
DeleteRegisteredModelTag: validate_can_update_registered_model,
SetModelVersionTag: validate_can_update_registered_model,
DeleteModelVersionTag: validate_can_delete_registered_model,
SetRegisteredModelAlias: validate_can_update_registered_model,
DeleteRegisteredModelAlias: validate_can_delete_registered_model,
GetModelVersionByAlias: validate_can_read_registered_model,
}
def get_before_request_handler(request_class):
return BEFORE_REQUEST_HANDLERS.get(request_class)
BEFORE_REQUEST_VALIDATORS = {
(http_path, method): handler
for http_path, handler, methods in get_endpoints(get_before_request_handler)
for method in methods
}
BEFORE_REQUEST_VALIDATORS.update(
{
(SIGNUP, "GET"): validate_can_create_user,
(GET_USER, "GET"): validate_can_read_user,
(CREATE_USER, "POST"): validate_can_create_user,
(UPDATE_USER_PASSWORD, "PATCH"): validate_can_update_user_password,
(UPDATE_USER_ADMIN, "PATCH"): validate_can_update_user_admin,
(DELETE_USER, "DELETE"): validate_can_delete_user,
(GET_EXPERIMENT_PERMISSION, "GET"): validate_can_manage_experiment,
(CREATE_EXPERIMENT_PERMISSION, "POST"): validate_can_manage_experiment,
(UPDATE_EXPERIMENT_PERMISSION, "PATCH"): validate_can_manage_experiment,
(DELETE_EXPERIMENT_PERMISSION, "DELETE"): validate_can_manage_experiment,
(GET_REGISTERED_MODEL_PERMISSION, "GET"): validate_can_manage_registered_model,
(CREATE_REGISTERED_MODEL_PERMISSION, "POST"): validate_can_manage_registered_model,
(UPDATE_REGISTERED_MODEL_PERMISSION, "PATCH"): validate_can_manage_registered_model,
(DELETE_REGISTERED_MODEL_PERMISSION, "DELETE"): validate_can_manage_registered_model,
}
)
def _is_proxy_artifact_path(path: str) -> bool:
return path.startswith(f"{_REST_API_PATH_PREFIX}/mlflow-artifacts/artifacts/")
def _get_proxy_artifact_validator(
method: str, view_args: Optional[Dict[str, Any]]
) -> Optional[Callable[[], bool]]:
if view_args is None:
return validate_can_read_experiment_artifact_proxy # List
return {
"GET": validate_can_read_experiment_artifact_proxy, # Download
"PUT": validate_can_update_experiment_artifact_proxy, # Upload
"DELETE": validate_can_delete_experiment_artifact_proxy, # Delete
}.get(method)
def authenticate_request() -> Union[Authorization, Response]:
"""Use configured authorization function to get request authorization."""
auth_func = get_auth_func(auth_config.authorization_function)
return auth_func()
@functools.lru_cache(maxsize=None)
def get_auth_func(authorization_function: str) -> Callable[[], Union[Authorization, Response]]:
"""
Import and return the specified authorization function.
Args:
authorization_function: A string of the form "module.submodule:auth_func"
"""
mod_name, fn_name = authorization_function.split(":", 1)
module = importlib.import_module(mod_name)
return getattr(module, fn_name)
def authenticate_request_basic_auth() -> Union[Authorization, Response]:
"""Authenticate the request using basic auth."""
if request.authorization is None:
return make_basic_auth_response()
username = request.authorization.username
password = request.authorization.password
if store.authenticate_user(username, password):
return request.authorization
else:
# let user attempt login again
return make_basic_auth_response()
@catch_mlflow_exception
def _before_request():
if is_unprotected_route(request.path):
return
authorization = authenticate_request()
if isinstance(authorization, Response):
return authorization
elif not isinstance(authorization, Authorization):
raise MlflowException(
f"Unsupported result type from {auth_config.authorization_function}: "
f"'{type(authorization).__name__}'",
INTERNAL_ERROR,
)
# admins don't need to be authorized
if sender_is_admin():
return
# authorization
if validator := BEFORE_REQUEST_VALIDATORS.get((request.path, request.method)):
if not validator():
return make_forbidden_response()
elif _is_proxy_artifact_path(request.path):
if validator := _get_proxy_artifact_validator(request.method, request.view_args):
if not validator():
return make_forbidden_response()
def set_can_manage_experiment_permission(resp: Response):
response_message = CreateExperiment.Response()
parse_dict(resp.json, response_message)
experiment_id = response_message.experiment_id
username = authenticate_request().username
store.create_experiment_permission(experiment_id, username, MANAGE.name)
def set_can_manage_registered_model_permission(resp: Response):
response_message = CreateRegisteredModel.Response()
parse_dict(resp.json, response_message)
name = response_message.registered_model.name
username = authenticate_request().username
store.create_registered_model_permission(name, username, MANAGE.name)
def delete_can_manage_registered_model_permission(resp: Response):
"""
Delete registered model permission when the model is deleted.
We need to do this because the primary key of the registered model is the name,
unlike the experiment where the primary key is experiment_id (UUID). Therefore,
we have to delete the permission record when the model is deleted otherwise it
conflicts with the new model registered with the same name.
"""
# Get model name from request context because it's not available in the response
name = request.get_json(force=True, silent=True)["name"]
username = authenticate_request().username
store.delete_registered_model_permission(name, username)
def filter_search_experiments(resp: Response):
if sender_is_admin():
return
response_message = SearchExperiments.Response()
parse_dict(resp.json, response_message)
# fetch permissions
username = authenticate_request().username
perms = store.list_experiment_permissions(username)
can_read = {p.experiment_id: get_permission(p.permission).can_read for p in perms}
default_can_read = get_permission(auth_config.default_permission).can_read
# filter out unreadable
for e in list(response_message.experiments):
if not can_read.get(e.experiment_id, default_can_read):
response_message.experiments.remove(e)
# re-fetch to fill max results
request_message = _get_request_message(SearchExperiments())
while (
len(response_message.experiments) < request_message.max_results
and response_message.next_page_token != ""
):
refetched: PagedList[Experiment] = _get_tracking_store().search_experiments(
view_type=request_message.view_type,
max_results=request_message.max_results,
order_by=request_message.order_by,
filter_string=request_message.filter,
page_token=response_message.next_page_token,
)
refetched = refetched[: request_message.max_results - len(response_message.experiments)]
if len(refetched) == 0:
response_message.next_page_token = ""
break
refetched_readable_proto = [
e.to_proto() for e in refetched if can_read.get(e.experiment_id, default_can_read)
]
response_message.experiments.extend(refetched_readable_proto)
# recalculate next page token
start_offset = SearchUtils.parse_start_offset_from_page_token(
response_message.next_page_token
)
final_offset = start_offset + len(refetched)
response_message.next_page_token = SearchUtils.create_page_token(final_offset)
resp.data = message_to_json(response_message)
def filter_search_registered_models(resp: Response):
if sender_is_admin():
return
response_message = SearchRegisteredModels.Response()
parse_dict(resp.json, response_message)
# fetch permissions
username = authenticate_request().username
perms = store.list_registered_model_permissions(username)
can_read = {p.name: get_permission(p.permission).can_read for p in perms}
default_can_read = get_permission(auth_config.default_permission).can_read
# filter out unreadable
for rm in list(response_message.registered_models):
if not can_read.get(rm.name, default_can_read):
response_message.registered_models.remove(rm)
# re-fetch to fill max results
request_message = _get_request_message(SearchRegisteredModels())
while (
len(response_message.registered_models) < request_message.max_results
and response_message.next_page_token != ""
):
refetched: PagedList[
RegisteredModel
] = _get_model_registry_store().search_registered_models(
filter_string=request_message.filter,
max_results=request_message.max_results,
order_by=request_message.order_by,
page_token=response_message.next_page_token,
)
refetched = refetched[
: request_message.max_results - len(response_message.registered_models)
]
if len(refetched) == 0:
response_message.next_page_token = ""
break
refetched_readable_proto = [
rm.to_proto() for rm in refetched if can_read.get(rm.name, default_can_read)
]
response_message.registered_models.extend(refetched_readable_proto)
# recalculate next page token
start_offset = SearchUtils.parse_start_offset_from_page_token(
response_message.next_page_token
)
final_offset = start_offset + len(refetched)
response_message.next_page_token = SearchUtils.create_page_token(final_offset)
resp.data = message_to_json(response_message)
AFTER_REQUEST_PATH_HANDLERS = {
CreateExperiment: set_can_manage_experiment_permission,
CreateRegisteredModel: set_can_manage_registered_model_permission,
DeleteRegisteredModel: delete_can_manage_registered_model_permission,
SearchExperiments: filter_search_experiments,
SearchRegisteredModels: filter_search_registered_models,
}
def get_after_request_handler(request_class):
return AFTER_REQUEST_PATH_HANDLERS.get(request_class)
AFTER_REQUEST_HANDLERS = {
(http_path, method): handler
for http_path, handler, methods in get_endpoints(get_after_request_handler)
for method in methods
}
@catch_mlflow_exception
def _after_request(resp: Response):
if 400 <= resp.status_code < 600:
return resp
if handler := AFTER_REQUEST_HANDLERS.get((request.path, request.method)):
handler(resp)
return resp
def create_admin_user(username, password):
if not store.has_user(username):
try:
store.create_user(username, password, is_admin=True)
_logger.info(
f"Created admin user '{username}'. "
"It is recommended that you set a new password as soon as possible "
f"on {UPDATE_USER_PASSWORD}."
)
except MlflowException as e:
if isinstance(e.__cause__, sqlalchemy.exc.IntegrityError):
# When multiple workers are starting up at the same time, it's possible
# that they try to create the admin user at the same time and one of them
# will succeed while the others will fail with an IntegrityError.
return
raise
def alert(href: str):
return render_template_string(
r"""
<script type = "text/javascript">
{% with messages = get_flashed_messages() %}
{% if messages %}
{% for message in messages %}
alert("{{ message }}");
{% endfor %}
{% endif %}
{% endwith %}
window.location.href = "{{ href }}";
</script>
""",
href=href,
)
def signup():
return render_template_string(
r"""
<style>
form {
background-color: #F5F5F5;
border: 1px solid #CCCCCC;
border-radius: 4px;
padding: 20px;
max-width: 400px;
margin: 0 auto;
font-family: Arial, sans-serif;
font-size: 14px;
line-height: 1.5;
}
input[type=text], input[type=password] {
width: 100%;
padding: 10px;
margin-bottom: 10px;
border: 1px solid #CCCCCC;
border-radius: 4px;
box-sizing: border-box;
}
input[type=submit] {
background-color: rgb(34, 114, 180);
color: #FFFFFF;
border: none;
border-radius: 4px;
padding: 10px 20px;
cursor: pointer;
font-size: 16px;
font-weight: bold;
}
input[type=submit]:hover {
background-color: rgb(14, 83, 139);
}
.logo-container {
display: flex;
align-items: center;
justify-content: center;
margin-bottom: 10px;
}
.logo {
max-width: 150px;
margin-right: 10px;
}
</style>
<form action="{{ users_route }}" method="post">
<div class="logo-container">
{% autoescape false %}
{{ mlflow_logo }}
{% endautoescape %}
</div>
<label for="username">Username:</label>
<br>
<input type="text" id="username" name="username">
<br>
<label for="password">Password:</label>
<br>
<input type="password" id="password" name="password">
<br>
<br>
<input type="submit" value="Sign up">
</form>
""",
mlflow_logo=MLFLOW_LOGO,
users_route=CREATE_USER,
)
@catch_mlflow_exception
def create_user():
content_type = request.headers.get("Content-Type")
if content_type == "application/x-www-form-urlencoded":
username = request.form["username"]
password = request.form["password"]
if store.has_user(username):
flash(f"Username has already been taken: {username}")
return alert(href=SIGNUP)
store.create_user(username, password)
flash(f"Successfully signed up user: {username}")
return alert(href=HOME)
elif content_type == "application/json":
username = _get_request_param("username")
password = _get_request_param("password")
user = store.create_user(username, password)
return jsonify({"user": user.to_json()})
else:
message = (
"Invalid content type. Must be one of: "
"application/x-www-form-urlencoded, application/json"
)
return make_response(message, 400)
@catch_mlflow_exception
def get_user():
username = _get_request_param("username")
user = store.get_user(username)
return jsonify({"user": user.to_json()})
@catch_mlflow_exception
def update_user_password():
username = _get_request_param("username")
password = _get_request_param("password")
store.update_user(username, password=password)
return make_response({})
@catch_mlflow_exception
def update_user_admin():
username = _get_request_param("username")
is_admin = _get_request_param("is_admin")
store.update_user(username, is_admin=is_admin)
return make_response({})
@catch_mlflow_exception
def delete_user():
username = _get_request_param("username")
store.delete_user(username)
return make_response({})
@catch_mlflow_exception
def create_experiment_permission():
experiment_id = _get_request_param("experiment_id")
username = _get_request_param("username")
permission = _get_request_param("permission")
ep = store.create_experiment_permission(experiment_id, username, permission)
return jsonify({"experiment_permission": ep.to_json()})
@catch_mlflow_exception
def get_experiment_permission():
experiment_id = _get_request_param("experiment_id")
username = _get_request_param("username")
ep = store.get_experiment_permission(experiment_id, username)
return make_response({"experiment_permission": ep.to_json()})
@catch_mlflow_exception
def update_experiment_permission():
experiment_id = _get_request_param("experiment_id")
username = _get_request_param("username")
permission = _get_request_param("permission")
store.update_experiment_permission(experiment_id, username, permission)
return make_response({})
@catch_mlflow_exception
def delete_experiment_permission():
experiment_id = _get_request_param("experiment_id")
username = _get_request_param("username")
store.delete_experiment_permission(experiment_id, username)
return make_response({})
@catch_mlflow_exception
def create_registered_model_permission():
name = _get_request_param("name")
username = _get_request_param("username")
permission = _get_request_param("permission")
rmp = store.create_registered_model_permission(name, username, permission)
return make_response({"registered_model_permission": rmp.to_json()})
@catch_mlflow_exception
def get_registered_model_permission():
name = _get_request_param("name")
username = _get_request_param("username")
rmp = store.get_registered_model_permission(name, username)
return make_response({"registered_model_permission": rmp.to_json()})
@catch_mlflow_exception
def update_registered_model_permission():
name = _get_request_param("name")
username = _get_request_param("username")
permission = _get_request_param("permission")
store.update_registered_model_permission(name, username, permission)
return make_response({})
@catch_mlflow_exception
def delete_registered_model_permission():
name = _get_request_param("name")
username = _get_request_param("username")
store.delete_registered_model_permission(name, username)
return make_response({})
def create_app(app: Flask = app):
"""
A factory to enable authentication and authorization for the MLflow server.
Args:
app: The Flask app to enable authentication and authorization for.
Returns:
The app with authentication and authorization enabled.
"""
_logger.warning(
"This feature is still experimental and may change in a future release without warning"
)
# secret key required for flashing
if not app.secret_key:
app.secret_key = str(uuid.uuid4())
store.init_db(auth_config.database_uri)
create_admin_user(auth_config.admin_username, auth_config.admin_password)
app.add_url_rule(
rule=SIGNUP,
view_func=signup,
methods=["GET"],
)
app.add_url_rule(
rule=CREATE_USER,
view_func=create_user,
methods=["POST"],
)
app.add_url_rule(
rule=GET_USER,
view_func=get_user,
methods=["GET"],
)
app.add_url_rule(
rule=UPDATE_USER_PASSWORD,
view_func=update_user_password,
methods=["PATCH"],
)
app.add_url_rule(
rule=UPDATE_USER_ADMIN,
view_func=update_user_admin,
methods=["PATCH"],
)
app.add_url_rule(
rule=DELETE_USER,
view_func=delete_user,
methods=["DELETE"],
)
app.add_url_rule(
rule=CREATE_EXPERIMENT_PERMISSION,
view_func=create_experiment_permission,
methods=["POST"],
)
app.add_url_rule(
rule=GET_EXPERIMENT_PERMISSION,
view_func=get_experiment_permission,
methods=["GET"],
)
app.add_url_rule(
rule=UPDATE_EXPERIMENT_PERMISSION,
view_func=update_experiment_permission,
methods=["PATCH"],
)
app.add_url_rule(
rule=DELETE_EXPERIMENT_PERMISSION,
view_func=delete_experiment_permission,
methods=["DELETE"],
)
app.add_url_rule(
rule=CREATE_REGISTERED_MODEL_PERMISSION,
view_func=create_registered_model_permission,
methods=["POST"],
)
app.add_url_rule(
rule=GET_REGISTERED_MODEL_PERMISSION,
view_func=get_registered_model_permission,
methods=["GET"],
)
app.add_url_rule(
rule=UPDATE_REGISTERED_MODEL_PERMISSION,
view_func=update_registered_model_permission,
methods=["PATCH"],
)
app.add_url_rule(
rule=DELETE_REGISTERED_MODEL_PERMISSION,
view_func=delete_registered_model_permission,
methods=["DELETE"],
)
app.before_request(_before_request)
app.after_request(_after_request)
return app