RAZ Client

RAZ Client python package provides plugin to boto3 library to use Apache Ranger for granular authorization for S3 access

Prerequisites

• Python 3.6 or higher
• Protocol Buffers version 4.21

Installation

To install using pip from the raz_client PyPI project:

$ pip install raz_client

Usage

• The client assumes a kinited user session and will use the same principle to negotiate the authentication with the RAZ server.
• Create a boto3 client of type s3.

  client = boto3.client("s3")
  

• Create a configuration object of type configuration by importing it from the raz_python package.

  conf = Configuration()
  

• Add the basic raz server configs by adding them via script or using a hadoop configuration file. Examples for both are present in the examples folder.
• Configure the boto3 client by calling the configure_ranger_raz(client, conf) method from the raz_client lib.
• The client is ready to be used as it is now.

Example

Look at the example directory for example usage of different options and different APIs.

Basic startup code for usage:

import boto3
import raz_client

client = boto3.client("s3")

# configure the client. The client uses the kerberos credentials of the logged in user for authorization
raz_client.configure_ranger_raz(client)

# To configure SSL certificate,
# 1. Download the certificate: CDP UI -> environment -> FreeIPA -> Get FreeIPA certificate
# 2. Configure the certificate path: 
# raz_client.configure_ranger_raz(client, ssl_file="<ssl_filepath>")

# list objects in bucket
result = client.list_objects(Bucket="<bucket name>", Prefix="/")
print(result)

Configuration

The Configuration object provided can be used to pass additional parameters to the client. The user specified configs will override the raz server default configs.

License

Copyright (c) 2023 Cloudera, Inc. All Rights Reserved. This software and any associated use of this software is governed exclusively by the Cloudera Standard License included in the accompanying LICENSE.txt file or found at Cloudera License