R包中安全缓存与存储个人访问令牌的最佳实践问询

你当前将令牌存在包的inst/extdata/cached_secrets目录下的做法存在几个隐患：

• 这个目录属于包的安装路径，通常是系统级或全局目录，多用户使用时会出现令牌冲突，且包更新时该目录可能被覆盖。
• 目录权限可能不够严格，存在敏感令牌被其他用户读取的风险。

以下是更安全、规范的缓存方案：

核心最佳实践 #

• 使用用户专属目录：用R内置的tools::R_user_dir()（R 4.0及以上版本支持）获取每个用户独立的数据存储目录，避免多用户冲突和包更新覆盖问题；若需兼容旧版本R，可使用rappdirs包的user_data_dir()函数。
• 严格控制文件权限：保存令牌时设置文件权限为仅当前用户可读（mode = "0600"），防止敏感信息泄露。
• 提前创建缓存目录：确保存储令牌的目录存在，避免保存操作报错。
• 按服务隔离令牌：为GitHub、Google、Calendly分别创建独立的缓存文件，便于管理和维护。

改进后的代码示例 #

# 获取用户专属的缓存目录，包名为metricminer
get_cache_dir <- function() {
  cache_dir <- tools::R_user_dir("metricminer", which = "data")
  # 目录不存在则创建，同时设置仅当前用户可访问的权限
  if (!dir.exists(cache_dir)) {
    dir.create(cache_dir, recursive = TRUE, mode = "0700")
  }
  cache_dir
}

# 缓存GitHub令牌的函数
cache_github_token <- function(token, cache_it = TRUE) {
  if (cache_it) {
    cache_path <- file.path(get_cache_dir(), "github_token.rds")
    # 保存时设置仅当前用户可读的权限
    saveRDS(token, cache_path, mode = "0600")
  }
}

# 使用示例
# cache_github_token(your_github_pat, cache_it = TRUE)

补充说明 #

• 读取令牌时，直接从get_cache_dir()返回的路径读取即可。
• 不要在包的代码中硬编码任何路径，始终用系统提供的目录函数，保证跨平台兼容性（Windows、macOS、Linux）。
• 若使用rappdirs包，需在包的DESCRIPTION文件中添加该依赖。

内容的提问来源于stack exchange，提问作者Howard Baik