SDK for Python

• Access Governance
• Account Management
• AI Anomaly Detection
• AI Language
• AI Speech
• AI Vision
• Analytics Cloud
• Announcements
• API Gateway
• Application Dependency Management
• Application Management
• Application Performance Monitoring
• Audit
• Autonomous Recovery
• Autoscaling (Compute)
• Bastion
• Big Data Service
• Blockchain Platform
• Budgets
• Build
• OCI Cache
• Certificates
• Cloud Bridge
• Cloud Migrations
• Compute Cloud@Customer
• Compute Instance Agent (Oracle Cloud Agent)
• Kubernetes Engine
• Container Instances
• Content Management
• Core Services (Networking, Compute, Block Volume)
• Cloud Guard
• Cloud Migrations
• Cluster Placement Groups
• Connector Hub
• Console Dashboard
• Data Catalog
• Data Flow
• Data Integration
• Data Labeling
• Data Safe
• Data Science
• Data Transfer
• Database
• Database Management
• Database Migration
• Database Tools
• Delegate Access Control
• Demand Signal
• DevOps
• Digital Assistant
• Digital Media
• Disaster Recovery
• DNS
• Document Understanding
• Email Delivery
• Enterprise Manager Warehouse
• Events
• Exadata Fleet Update
• File Storage
• Fleet Application Management
• Functions
• Fusion Apps as a Service
• Generative AI
• Generative AI Agent
• Generative AI Inference
• Generic Artifacts
• Globally Distributed Database
• GoldenGate
• Governance Rules
• Health Checks
• IAM
• Identity Domains
• Integration Cloud
• Java Management
• Java Management Service Downloads
• Key Management (for the Vault service)
• License Manager
• Limits
• Load Balancer
• Logging
• Logging Analytics
• Logging Search
• Logging Ingestion
• Managed Access
• Management Agent Cloud
• Management Dashboard
• Marketplace
• Marketplace Private Offer
• Monitoring
• HeatWave
• Network Firewall
• Network Load Balancing
• Network Monitoring
• Networking Topology
• NoSQL Database Cloud
• Notifications
• Object Storage
• OCI Control Center
• OCI Registry
• OCI Secure Desktops
• OneSubscription
• Operations Insights
• Operator Access Control
• Optimizer
• Organizations
• OS Management
• OS Management Hub
• PostgreSQL
• Process Automation
• Publisher
• Queue Service
• Quotas
• Resource Manager
• Resource Scheduler
• Roving Edge Infrastructure
• Search
• Secret Management (for the Vault service)
• Secure Desktops
• Security Attribute
• Service Catalog
• Service Mesh
• Source Code Management
• Stack Monitoring
• Streaming
• Support Management
• Threat Intelligence
• Usage
• Visual Builder
• VMWare Solution
• Vulnerability Scanning
• Web Application Acceleration and Security
• Work Requests (Compute, Database)
• Zero Trust Packet Routing

You can use Resource Manager to install the Oracle Cloud Development Kit on a Compute instance in your compartment. The Oracle Cloud Development Kit includes the SDK for Python, along with other Oracle development tools.

If you're using Oracle Linux 7 or 8, you can use yum to install the OCI SDK for Python.

The following example shows how to use yum to install the OCI SDK for Python 3.6:

sudo yum install python36-oci-sdk

This example shows how to use yum to install the OCI SDK for Python 2.7:

sudo yum install python-oci-sdk

Client Side Encryption allows you to encrypt data on the client side before storing it locally or using it with other Oracle Cloud Infrastructure services.

To use client-side encryption, you must create a master encryption key (MEK) using the Key Management Service. This can be done using the CreateKey or ImportKey operations.

The MEK is used to generate a Data Encryption Key (DEK) to encrypt each payload. A encrypted copy of this DEK (encrypted under the MEK) and other pieces of metadata are included in the encrypted payload returned by the SDKs so that they can be used for decryption.

import oci
 
# user supplied vars
vault_id = TEST_VAULT_OCID
master_key_id = TEST_MASTER_KEY_ID
data_to_encrypt_bytes = b"This is a secret message"
 
config = oci.config.from_file()
kms_master_key = oci.encryption.KMSMasterKey(
    config=config, master_key_id=master_key_id, vault_id=vault_id
)
 
kms_master_key_provider = oci.encryption.KMSMasterKeyProvider(
    config=config,
    kms_master_keys=[kms_master_key]
)
 
crypto_result = crypto.encrypt(kms_master_key_provider, data_to_encrypt_bytes)
ciphertext = crypto_result.get_data()
print("ciphertext: {}".format(ciphertext))
 
# decrypt string example
crypto_result = crypto.decrypt(ciphertext, kms_master_key_provider)
print("unencrypted text: {}".format(crypto_result.get_data()))

import oci
import shutil
 
# user supplied vars
vault_id = TEST_VAULT_OCID
master_key_id = TEST_MASTER_KEY_ID
file_to_encrypt = "/file/to/encrypt/message.txt"
output_encrypted_file = "/tmp/message.txt.encrypted"
output_decrypted_file = "/tmp/message.txt.decrypted"
 
# setup OCI KMS keys
config = oci.config.from_file()
kms_master_key = oci.encryption.KMSMasterKey(
    config=config, master_key_id=master_key_id, vault_id=vault_id
)
 
kms_master_key_provider = oci.encryption.KMSMasterKeyProvider(
    config=config,
    kms_master_keys=[kms_master_key]
)
 
# encrypt stream example
with open(output_encrypted_file, 'wb') as output_stream, open(file_to_encrypt, 'rb') as stream_to_encrypt:
    with crypto.create_encryption_stream(
        kms_master_key_provider,
        stream_to_encrypt
    ) as encryption_stream:
        shutil.copyfileobj(encryption_stream, output_stream)
 
# decrypt stream example
with open(output_decrypted_file, 'wb') as output_stream, open(output_encrypted_file, 'rb') as stream_to_decrypt:
    with crypto.create_decryption_stream(
        stream_to_decrypt,
        kms_master_key_provider
    ) as decryption_stream:
        shutil.copyfileobj(decryption_stream, output_stream)