Coverage for python / lsst / daf / butler / remote_butler / authentication / interface.py: 0%

1# This file is part of daf_butler. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://www.lsst.org). 

6# See the COPYRIGHT file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

9# This software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

15# This program is free software: you can redistribute it and/or modify 

16# it under the terms of the GNU General Public License as published by 

17# the Free Software Foundation, either version 3 of the License, or 

18# (at your option) any later version. 

19# 

20# This program is distributed in the hope that it will be useful, 

21# but WITHOUT ANY WARRANTY; without even the implied warranty of 

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <http://www.gnu.org/licenses/>. 

27 

28from typing import Protocol 

29 

30 

31class RemoteButlerAuthenticationProvider(Protocol): 

32 """Interface for looking up authentication headers for use with Butler 

33 server. Objects implementing this interface must also be 

34 pickleable, because internal methods for accessing files sometimes execute 

35 code in other processes. 

36 """ 

37 

38 def get_server_headers(self) -> dict[str, str]: 

39 """Return HTTP headers that must be sent to the Butler server to 

40 authenticate API requests. 

41 """ 

42 

43 def get_datastore_headers(self) -> dict[str, str]: 

44 """Return HTTP headers that must be sent to the server hosting artifact 

45 files to authenticate file downloads. 

46 """