跳过主内容
Capgo logo
开发 移动 更新

API密钥安全性

了解如何保护用户数据并遵守应用商店指南的必备策略，包括存储、传输和管理API密钥。

马丁·多纳迪

马丁·多纳迪

内容营销
API密钥安全性

保护您的 API密钥 保护用户数据和遵守应用商店规则，安全性至关重要。 暴露密钥可能导致数据泄露、服务滥用和账户被劫持。

关键点摘录：

  • 避免将密钥存储在 code 中: 使用环境变量或安全文件。
  • 使用平台工具: iOS Keychain 和 Android EncryptedSharedPreferences.
  • 加密 API 密钥: 使用 AES-256 加密提供额外的安全层。
  • 安全传输: 始终使用 HTTPS 并考虑 SSL 证书固定。
  • 监控和旋转密钥: 定期旋转密钥并监控使用情况以查找异常。

通过实施这些实践，

Secure API Key Storage Methods

Remove API Keys from Source Code

从源code中删除API密钥

  • 将__CAPGO_KEEP_0__密钥直接包含在源__CAPGO_KEEP_1__中可能会导致通过反汇编或仓库泄露。为了避免这种情况，请考虑以下方法: 使用 环境变量
  • 进行本地开发。 将密钥存储在 安全的配置文件中
  • 依赖 远程配置服务 来管理密钥。

对于 iOS，考虑使用 XCConfig 文件 将配置与代码库分开。 在 Android 上，您可以使用 gradle.properties:

# Store in ~/.gradle/gradle.properties
API_KEY=your_key_here

# Reference in build.gradle
buildConfigField "String", "API_KEY", "\"${project.API_KEY}\""

平台安全工具

Take advantage of platform-specific tools to enhance security when storing API keys.

在 iOS 上，使用 Keychain 服务 进行安全存储：

let query: [String: Any] = [
    kSecClass as String: kSecClassGenericPassword,
    kSecAttrAccount as String: "APIKey",
    kSecValueData as String: apiKey.data(using: .utf8)!
]
let status = SecItemAdd(query as CFDictionary, nil)

在 Android 上，利用 EncryptedSharedPreferences 用于安全的密钥存储:

val masterKey = MasterKey.Builder(context)
    .setKeyScheme(MasterKey.KeyScheme.AES256_GCM)
    .build()

val sharedPreferences = EncryptedSharedPreferences.create(
    context,
    "secret_shared_prefs",
    masterKey,
    EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
    EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
)

环境隔离密钥

为开发、测试和生产环境使用不同的API密钥。每个环境应该具有:

  • 独特的密钥轮换计划
  • 使用监控
  • 严格的访问控制

将环境特定的密钥存储在 安全的CI/CD变量 而不是配置文件。这确保了密钥在支持自动化构建过程时仍保持保护状态。此外，请确保在传输密钥时保护密钥的机制已建立

高级移动iOS安全性-运行时攻击&API密钥…

API 传输安全

API 的传输安全是保护用户数据和遵守应用商店要求的关键。强大的传输安全措施有助于防止中间人攻击和未经授权的访问。

HTTPS 实现

为了安全地传输 API 通信，请始终将 HTTP 流量重定向到 HTTPS。使用 TLS 1.3 或更高版本，并从受信任的证书颁发机构获取 SSL 证书。

Node.js Express 应用程序的 HTTPS 基本示例： 为了提供额外的保护，请考虑实施证书固定。 证书固定

const express = require('express');
const app = express();

// Redirect HTTP to HTTPS
app.use((req, res, next) => {
    if (!req.secure) {
        return res.redirect('https://' + req.headers.host + req.url);
    }
    next();
});

证书固定确保服务器的 SSL 证书与受信任的副本匹配，从而防止使用伪造证书。

在 iOS 上，可以使用以下方法实施证书固定：

以下是示例：

For an added layer of protection, consider implementing certificate pinning. URLSessionOn iOS, you can implement certificate pinning using

class APIManager: NSObject, URLSessionDelegate {
    func urlSession(_ session: URLSession, didReceive challenge: URLAuthenticationChallenge, completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) {
        guard let serverTrust = challenge.protectionSpace.serverTrust,
              let certificate = SecTrustGetCertificateAtIndex(serverTrust, 0) else {
            completionHandler(.cancelAuthenticationChallenge, nil)
            return
        }

        // Compare certificate with pinned certificate
        if validateCertificate(certificate) {
            completionHandler(.useCredential, URLCredential(trust: serverTrust))
        } else {
            completionHandler(.cancelAuthenticationChallenge, nil)
        }
    }
}

除了安全传输外，还要在应用层面加密API密钥。

API密钥加密

加密API密钥 加密Capgo密钥还能增加安全层。例如，Capgo在更新应用时使用端到端加密。

“The only solution with true end-to-end encryption, others just sign updates” - Capgo [1]

为了加密API密钥，使用可靠的加密算法。以下是使用Node.js中的AES-256-GCM加密API密钥的示例：

const crypto = require('crypto');

function encryptAPIKey(apiKey, encryptionKey) {
    const iv = crypto.randomBytes(16);
    const cipher = crypto.createCipheriv('aes-256-gcm', encryptionKey, iv);

    let encrypted = cipher.update(apiKey, 'utf8', 'hex');
    encrypted += cipher.final('hex');

    return {
        encrypted: encrypted,
        iv: iv.toString('hex'),
        tag: cipher.getAuthTag().toString('hex')
    };
}

结合HTTPS、证书固定和加密确保了API密钥的强大防御。

API密钥安全管理

有效管理API密钥意味着密切关注它们的使用情况、定期轮换并严格控制访问权限。这些步骤有助于保护敏感数据并确保遵守应用商店的要求。

使用监控

跟踪API密钥使用情况至关重要，以便 spotting任何异常活动。使用实时分析监控：

  • 请求模式和流量
  • __CAPGO_KEEP_0__
  • 错误率和类型
  • 认证失败

Node.js 中的示例：

const apiMetrics = {
    trackRequest: (apiKey, endpoint) => {
        // Log request details
        const requestData = {
            timestamp: new Date().toISOString(),
            endpoint,
            apiKey: hashKey(apiKey),
            geoLocation: getRequestLocation(),
            responseTime: calculateResponseTime()
        };

        // Alert on suspicious patterns
        if (isAnomalous(requestData)) {
            notifySecurityTeam(requestData);
        }
    }
};

密钥轮换计划

一旦您掌握了使用情况，请确保定期轮换密钥。 自动化轮换过程可以帮助您遵守应用商店的要求。 以下是轮换策略：

  • 紧急轮换： 如果您怀疑存在泄露，请立即禁用密钥。
  • 计划轮换： 每季度更新生产密钥。
  • 开发轮换： 每月刷新测试环境密钥。

为了减少中断，使用过渡期进行关键更改：

const keyRotation = {
    oldKey: process.env.OLD_API_KEY,
    newKey: process.env.NEW_API_KEY,
    transitionPeriod: 7 * 24 * 60 * 60 * 1000, // 7 days
    startDate: new Date()
};

访问控制设置

监控和轮换只是等式的一部分。您还需要强制执行严格的访问控制。根据必要性分配权限，并坚持最小特权原则：

const accessControl = {
    validateAccess: (apiKey, requestedOperation) => {
        const keyPermissions = getKeyPermissions(apiKey);
        const environmentType = getCurrentEnvironment();

        return isOperationAllowed(keyPermissions, requestedOperation, environmentType);
    }
};

定期审查谁有访问权限，根据需要调整权限，并设置自动警报以监控异常活动。这些措施将帮助您保持强大的安全性，同时遵守应用商店规则。

Capgo 安全功能

Capgo 实时更新仪表板界面

Capgo 强化应用安全性，通过结合其平台内置的安全存储和传输方法以及先进功能。

Capgo 安全架构

Capgo 的系统已成功交付超过 2350 万个 安全更新 到 750 个生产应用 [1]. It uses 使用end-to-end encryption

const capgoSecurity = {
    encryptionType: 'end-to-end',
    keyStorage: {
        separate: true,
        encrypted: true,
        environment: process.env.NODE_ENV
    },
    updateVerification: async (update) => {
        const isValid = await verifySignature(update);
        const isAuthorized = await checkUserPermissions(update.userId);
        return isValid && isAuthorized;
    }
};

This design not only safeguards API keys but also simplifies compliance with app store requirements.

这种设计不仅保护了__CAPGO_KEEP_0__密钥，还简化了与应用商店要求的遵从性。

Capgo ensures updates are delivered quickly and securely, achieving an 82% global success rate, with 95% of active users receiving updates within 24 hours [1]__CAPGO_KEEP_0__确保更新快速且安全地传递，实现了82%的全球成功率，95%的活跃用户在24小时内接收到更新

  • . 其特性有助于解决潜在的漏洞:
  • 与应用商店政策一致的自动密钥轮换
  • 针对特定环境的部署控制

用于管理更新的细粒度权限

Capgo works seamlessly with CI/CD platforms to enhance API key protection. Here’s an example of its integration:

capgo_deployment:
    environment:
        - CAPGO_API_KEY: ${SECURED_API_KEY}
        - APP_ENV: production
    security:
        - signature_verification: true
        - key_rotation: enabled
        - access_control: role_based
安全功能 实施
密钥加密 在构建和部署过程中进行端到端加密
访问控制 基于角色的权限控制
审计日志 所有部署活动的详细日志
版本控制 安全跟踪部署的更新

“端到端加密。只有您的用户才能解密更新，其他人都不能。” [1] - Capgo

Summary

API密钥的安全性对于满足应用商店的要求和保护用户数据至关重要。以下是一些关键实践和下一步骤的快速概述。

Security Checklist

以下表格突出了保护API密钥的重要步骤，同时保持与苹果和谷歌标准的一致性:

Security Measure Implementation Requirements Compliance Impact
Storage Security 使用端到端加密和分离环境 符合苹果/谷歌数据保护规则
Transport Layer 强制使用HTTPS并使用SSL证书固定 在传输过程中保护数据
访问控制 应用基于角色的权限并跟踪 访问日志 阻止未经授权的访问
密钥管理 自动旋转密钥并使用环境特定的密钥 保持强大的持续性安全

参考此清单作为指南来保护您的API密钥

下一步

  1. 审计当前实施

    审查您的现有密钥存储和传输方法，特别关注加密和源code暴露的弱点。

  2. Implement Security Measures

    应用端到端加密来降低风险并满足应用商店要求。

  3. Establish Monitoring Systems

    设置自动警报并定期进行审计以确保持续安全。

“App Store compliant” - Capgo [1]

Keep going from API Key Security for App Store Compliance

如果您正在使用 API Key Security for App Store Compliance 来规划安全性和合规性，连接它与 加密 加密 合规 关于 Compliance 的实现细节 Capgo 安全扫描器 关于 Capgo 安全扫描器 的产品工作流程 Capgo 安全 关于 Capgo 安全 的产品工作流程 Capgo 信任中心 关于 Capgo 信任中心 的产品工作流程

实时更新 Capacitor 应用

当 web 层面的 bug 活跃时，通过 Capgo 直接将修复推送给用户，而不是等待几天的应用商店审批。用户在后台接收更新，而原生变化仍然在正常的审批路径中

立即开始

最新博客

Capgo 为您提供创建真正专业的移动应用所需的最佳见解。

Capacitor 应用中的双向通信
开发 移动 +1
2025年4月26日

Capacitor 应用中的双向通信

避免的5种OTA更新常见错误
开发 安全 +1
2025年4月13日

避免的5种OTA更新常见错误

移动应用实时更新的5种安全最佳实践
开发 移动 +1
2025年1月14日

移动应用实时更新的5种安全最佳实践

查看我们博客中的所有内容