S3GatewayHandler

Service handler for generating pre-signed URLs for S3 storages. Permissions to request a URL for a given action are mapped against FC permissions This service can serve presigned URL for any S3 storage it has the credentials for.

S3Gateway options

S3Gateway
{
  Port = 9169
  Authorization
  {
    Default = authenticated
  }
}

class DIRAC.DataManagementSystem.Service.S3GatewayHandler.S3GatewayHandler(handlerInitDict, trid)

Bases: RequestHandler

class S3GatewayHandler

__init__(handlerInitDict, trid)

Constructor

Parameters:

handlerInitDict (dictionary) – Information vars for the service
trid (object) – Transport to use

auth_ping = ['all']

auth_refreshConfiguration = ['CSAdministrator']

auth_whoami = ['all']

export_createPresignedUrl(storageName, s3_method, urls, expiration)

Generate a presigned URL for a given object, given method, and given storage Permissions are checked against the DFC

Parameters:

storageName – SE name
s3_method – name of the S3 client method we want to perform.
urls – Iterable of urls. If s3_method is put_object, it must be a dict <url:fields> where fields is a dictionary (see ~DIRAC.Resources.Storage.S3Storage.S3Storage.createPresignedUrl)
expiration – duration of the token

static export_echo(data)

This method is used for testing performance of the service

Parameters:: data (str) – data to be sent back to the caller
Returns:: S_OK, Value is the input data

export_ping()

static export_refreshConfiguration(fromMaster)

Force refreshing the configuration data

Parameters:: fromMaster (bool) – flag to refresh from the master configuration service

export_whoami(): A simple whoami, returns all credential dictionary, except certificate chain object.

classmethod getCSOption(optionName, defaultValue=False)

Get an option from the CS section of the services

Returns:: Value for serviceSection/optionName in the CS being defaultValue the default

getRemoteAddress()

Get the address of the remote peer.

Returns:: Address of remote peer.

getRemoteCredentials()

Get the credentials of the remote peer.

Returns:: Credentials dictionary of remote peer.

initialize(): Initialize this instance of the handler (to be overwritten)

classmethod initializeHandler(serviceInfoDict): initialize handler

srv_disconnect(trid=None)

classmethod srv_disconnectClient(trid)

srv_getActionTuple()

classmethod srv_getCSOption(optionName, defaultValue=False)

Get an option from the CS section of the services

Returns:: Value for serviceSection/optionName in the CS being defaultValue the default

srv_getClientSetup()

srv_getClientVO()

srv_getClientVersion()

srv_getFormattedRemoteCredentials()

classmethod srv_getMonitor()

srv_getRemoteAddress()

Get the address of the remote peer.

Returns:: Address of remote peer.

srv_getRemoteCredentials()

Get the credentials of the remote peer.

Returns:: Credentials dictionary of remote peer.

classmethod srv_getServiceName()

srv_getTransportID()

classmethod srv_getURL()

classmethod srv_msgCreate(msgName)

srv_msgReply(msgObj)

classmethod srv_msgSend(trid, msgObj)

transfer_bulkFromClient(bulkId, token, bulkSize, fileHelper)

transfer_bulkToClient(bulkId, token, fileHelper)

transfer_fromClient(fileId, token, fileSize, fileHelper)

transfer_listBulk(bulkId, token, fileHelper)

transfer_toClient(fileId, token, fileHelper)

types_createPresignedUrl = [<class 'str'>, <class 'str'>, (<class 'dict'>, <class 'list'>), <class 'int'>]

types_echo = [<class 'str'>]

types_ping = []

types_refreshConfiguration = [<class 'bool'>]

types_whoami = []