openai key path的进一步展开说明

怎样使用环境变量、Azure Vault和Streamlit Secrets来保护Azure OpenAI密钥

摘要：

在快节奏的现代世界中，保护敏感数据和凭据相当重要。在使用Azure和OpenAI时，确保存储API密钥和其他凭据的安全性相当重要。一种常见的做法是使用环境变量。但是，环境变量其实不总是最安全的选择，还有更好的替换方案。

在本博客文章中，我们将探讨怎样使用环境变量、Azure Key Vault和Streamlit Secrets来保护Azure OpenAI密钥。我们还将介绍保护API密钥的最好实践，并提供示例，以帮助您在自己的项目中实行这些技术。

介绍：

Azure OpenAI是一个强大的平台，允许开发人员范围化构建和部署AI模型。但是，与任何平台一样，确保数据和凭据的安全性非常重要。其中一种方法是使用环境变量来存储API密钥。但是，环境变量可以被具有服务器访问权限的任何人访问，使它们不太安全。

为了解决这个问题，可使用Azure Key Vault来安全存储和管理API密钥。另外，环境变量允许您将敏感数据存储在代码以外，Azure Vault提供安全的密钥存储，而Streamlit Secrets允许您在Streamlit利用程序中安全访问密钥。

安装：

在开始之前，您需要完成以下几项设置：

创建Azure账户并定阅Azure OpenAI。

在本地机器上安装Azure CLI。

安装Streamlit库（pip install streamlit）。

安装完成后：

面临的挑战：

保护密钥的最大挑战之一是确保它们不会心外暴露。如果将它们硬编码到代码中或将它们存储在不安全的位置，这类情况可能产生。通过使用环境变量、Azure Vault和Streamlit Secrets，我们可以确保密钥的安全存储，并且只能由授权的方访问。

以下是使用环境变量、Azure Vault和Streamlit Secrets来保护Azure OpenAI密钥的步骤：

将Azure OpenAI密钥存储在环境变量中：

打开命令提示符或终端，输入以下命令：

export OPENAI_KEY=

这将将您的密钥存储在名为OPENAI_KEY的环境变量中。

最好实践：为您的环境变量使用唯一且复杂的名称，以避免意外暴露。

创建Azure Key Vault：

登录Azure门户并创建一个新的Key Vault。

为Key Vault生成一个新的访问密钥。

2a> # 创建一个新的Key Vault实例

az keyvault create –name mykeyvault –resource-group myresourcegroup –location westus2

最好实践：使用诸如多因素身份验证之类的强身份验证方法保护您的Azure账户。

2b> # 向Key Vault添加一个密钥

az keyvault secret set –name myapikey –vault-name mykeyvault –value

将Azure OpenAI密钥存储在Azure Key Vault中：

使用Azure CLI，输入以下命令：

az keyvault secret set –vault-name –name openai-key –value

这将在Azure Key Vault中存储您的Azure OpenAI密钥。

最好实践：使用基于角色的访问控制确保只有授权的用户可以访问Key Vault。

在Streamlit利用程序中使用Streamlit Secrets访问Azure OpenAI密钥：

在您的Streamlit利用程序中，导入Streamlit Secrets库。

使用Azure CLI从Key Vault中检索Azure OpenAI密钥：

az keyvault secret show –vault-name –name openai-key –query value -o tsv

使用Streamlit Secrets安全地访问您的密钥：

st.secrets[‘openai-key’]

示例1：

接下来，让我们创建一个Streamlit利用程序，使用Azure SDK从Key Vault中检索我们的API密钥：

import os

from azure.identity import DefaultAzureCredential

from azure.keyvault.secrets import SecretClient

# 设置Key Vault客户端

credential = DefaultAzureCredential()

client = SecretClient(vault_url=os.environ[“AZURE_KEYVAULT_URL”], credential=credential)

# 从Key Vault中检索API密钥

在这个示例中，Azure OpenAI密钥是从Streamlit密钥加载的，并用于向Azure OpenAI API发送要求。该密钥没有在代码中暴露，使其更安全。

api_key = client.get_secret(“myapikey”).value

示例2：使用Streamlit Secrets保护Azure OpenAI密钥：

import streamlit as st

import os

# 从Streamlit密钥加载Azure OpenAI密钥

key = st.secrets[“azure_openai_key”]

# 使用密钥向Azure OpenAI API发送要求

response = requests.get(“https://api.openai.com/v1/engines/davinci-codex/completions”, headers={“Authorization”: f”Bearer {key}”})

# 在利用程序中使用API密钥

最好实践：将您的Streamlit利用程序的范围限制在仅限需要访问密钥的用户。

示例3：使用Streamlit “secrets”

这是使用Streamlit secrets的最简单方法：

1.在您的代码目录中创建一个名为“ .streamlit”的文件夹。

2.在“ .streamlit”文件夹下创建一个名为“ secrets.toml”的文件。

3.在“ secrets.toml”中为密钥分配一个路径。

路径 = ‘363e5eaaaaaabbbbbccccc’

流程以下：projectfolder.streamlit

在代码中调用密钥时使用此代码：openai.api_key = st.secrets[‘path’]

确保添加其他凭据。将以下所示：

# 设置OpenAI API凭据

openai.api_type = “azure”

openai.api_base = ‘https://xxxxxx.openai.azure.com/’

openai.api_version = “2023-03⑴5-preview”

openai.api_key = st.secrets[‘path’]

示例4：使用环境变量

为了说明如何安全存储Azure OpenAI密钥，让我们斟酌一个使用GPT⑶语言模型生成文本的示例利用程序。首先，我们将将API密钥存储为环境变量，可以通过将以下行添加到您的代码中来完成：

import os

os.environ[“OPENAI_API_KEY”] = “your_api_key_here”

虽然这是一个简单的解决方案，但其实不是最安全的，由于任何具有对代码访问权限的人都可以轻松查看您的API密钥。相反，我们可使用Azure Vault来安全存储密钥并以编程方式访问它。这可以通过在Azure Vault中创建一个密钥，并使用Azure Key Vault库在代码中检索它来完成：

from azure.keyvault.secrets import SecretClient

from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()

client = SecretClient(vault_url=”https://yourvaultname.vault.azure.net/”, credential=credential)

key = client.get_secret(“openai-api-key”)

os.environ[“OPENAI_API_KEY”] = key.value

整体最好实践：

为了确保Azure OpenAI密钥的安全性和机密性，请遵守以下最好实践：

永久不要将密钥硬编码到代码中或以纯文本文件存储。

使用安全的密钥管理解决方案，如Azure Key Vault或Streamlit Secrets来保护您的密钥。

定期更换密钥，并撤消任何未使用的密钥。

使用Azure AD身份验证以控制对密钥的访问。

监视和审计密钥使用以检测任何未经授权的访问。

结论：

保护Azure OpenAI密钥对避免未经授权的访问和滥用相当重要。通过使用Azure Key Vault和Streamlit Secrets，您可以安全存储和使用密钥。记住遵守密钥保护的最好实践，以确保您的利用程序的安全性。

参考资料：

Azure Key Vault文档：https://docs.microsoft.com/en-us/azure/key-vault/

openai key path的常见问答Q&A

import openai

openai.api_key = "your-api-key"

def chat_with_gpt(prompt):
    response = openai.Completion.create(
        engine="text-davinci-003",
        prompt=prompt,
        max_tokens=100,
        temperature=0.7,
        n=1,
        stop=None,
        timeout=5
    )
    
    return response.choices[0].text.strip()

# 示例对话交互
prompt = "你好，我想了解一些信息。"
response = chat_with_gpt(prompt)
print(response)

pip install openai