box / box/box-python-sdk

Disable certain functionalities in RemoteOAuth2Mixin

未关闭
#176 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
breaking enhancement
主要语言
Python
星标
459
派生
223
平均合并
8 小时 57 分钟
30 天内合并 PR
13

描述

When using RemoteOAuth2Mixin, all `/token` calls are delegated to another process or server. Thus:
- The `client_id` and `client_secret` shouldn't be required. In fact, they perhaps shouldn't even be allowed to be passed. Clients that need to do remote auth should be discouraged from having any of their credentials hard-coded, especially since they aren't even needed.
- `store_tokens` should perhaps be disallowed. Since the tokens are owned by the remote process, it should be in control of where its tokens go. If a client needs to restart, it should get its tokens from the remote process/server, not from its own token store.
- `box_device_id` and `box_device_name` are useless if we're not making `/token` calls.
- `refresh_token` should never be available to the client, so it shouldn't be possible to pass this.

Also, since the remote process/server owns the tokens, we should possibly disable `revoke()`. If we do that, then:
- We definitely don't need `client_id` and `client_secret` anymore, since they would never be used.
- For the same reason, we also don't need `network_layer` anymore.
- We might not need `refresh_lock` anymore. Presumably, the remote server can handle its own locking, without the clients needing to coordinate.

`revoke` could be made to `pass` (`DeveloperTokenAuth` does this) or `raise`, and the unneeded constructor arguments can be passed as `None` to the super-class, so that `TypeError` is raised if a user tries passing any of them.

Alternatively, factor this into #173, and create a common base-class that doesn't have any of these functionalities.

This would be a breaking change, so consider this for 2.0.0.

贡献指南

打开贡献指南

调研方向

Start by reading RemoteOAuth2Mixin and DeveloperTokenAuth, then review the common-base proposal in issue #173. Resolve whether revoke() and the listed constructor options should be disabled or removed, and define the intended breaking-change behavior for the 2.0.0 release.

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
api, authentication, security
Issue 类型
重构
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。