更新情報
2021.09.17
・キーチェーンの削除をしないでPATを差し替える方法を追記。
・パーソナルアクセストークンをPATに省略と、用語として記載。
・余談を追加。
・タイトルを変更。(個人アクセストークン→パーソナルアクセストークン)
2022.03.21
←最新
・参考記事にGitHubのドキュメントURLを追加。
・なぜPATの期限を無制限にしない方がいいのか?の参考記事を追加
・前置きにWindows非対応記事である旨追記
はじめに
※本記事はWindowsに対応していない箇所があります。
※ページ下部に参考になりそうな記事を貼っておいたのでそちらを参照頂ければ幸いです。
事の発端は同僚からの、
「アクセストークン期限切れし再作成したがpushができない」との相談を受けことに始まります。
自分のパーソナルアクセストークン(以降、PAT)の期限を確認したら期限切れまで1週間切っていたので、
ついでに再作成とパスワード再設定をやり、
そこで参照したいろんな記事の集約+αでまとめてみました。
結論といたしましては、
2021年8月13日にパスワード認証が廃止されたことに伴い行なったであろう、
PATの再作成 & 認証情報の削除と再登録を行う感じです。
[用語]
個人アクセストークン = パーソナルアクセストークン = PAT
Personal Access Tokenの有効期限
■設定したPATの期限は以下設定画面から確認できます。
Personal access tokens
期限切れが近い時は、「⚠️Expires on 日付」と注意喚起マーク付きの表示になっています。
今回は解説用にテストトークンを作成しました。
■更新の必要がある方は、1週間前に登録アドレス宛にの期限が近い旨、
通知メールが届いているかと思います。
作業
①トークンの期日設定と再作成
期限の近いトークンの「⚠️Expires…」 をクリックし設定画面へ移動。
任意の期限(Expiration)を設定し、トークンを再作成(Regenerate token)しましょう。
蛇足的ですが、ページ移動後再表示ができない為、
作成した際に表示されたPATは必ずコピーしておきましょう!!
[クリックしてね] No Expiration(無期限)は注意
有効期限に設定項目にNo Expiration(無期限)もありますが、選択すると注意喚起が表示されます。 無期限の危険性については、改めて書き加える予定ですが、
現時点では漏洩リスクなどセキュリティ面で危険、くらいの認識でもいいと思います。
通常はPJの期間内のみに設定することなどが多いんじゃないかと推測します。
→以下2022.03.21追記
無制限での設定について、やはりセキュリティ面での危険性に対して講じる策という認識でOKです。
また会社で担当するプロジェクトごとで、個人アカウントではなく共通アカウントを使用する場合などについても期限を設けて使用するのがベターでしょう。
短いスパンで更新するのが面倒な方は、半年くらいで設定しておくといいのではないでしょうか。
②認証情報の削除と再登録
■macユーザー
キーチェーンアクセスからgithub.com(インターネットパスワード)を削除。
Webフォームパスワード削除の必要はありません。
SourceTreeを使用している方は github.com Access Key for… も削除しましょう。
検索窓にgit,githubなど入力しても出てこない時は、
スクロールして探してみてください!検索に引っかからない事象も確認しました。
また、検索で出たのに削除ができない場合も同様です。スクロールし、見つけたものを削除してみてください。
ここを削除しないで、PATの再作成のみだとプッシュした際に
remote: Invalid username or password.
のような表示が出ると思います。
任意のコミットをプッシュした際に、ユーザー名とパスワードを求められるので、
パスワードにコピーしておいたトークンを入力し完了です!
ソースツリーについてもプッシュ時にパスワードを求められますので、
コピーしたPATを入力すればOKです。
[クリックしてね] いやいや、pushできないんですけど!って方いたら
キーチェーンの削除しようとしたけど検索しても、スクロールで探してもなかった!って話を聞きました。 キーチェーンに出てこない原因は筆者にも分かりかねます。 分かりかねますが、時間が少し時間を空けたら問題なくできたとのことでしたので、 一旦放置するか再起動でもしましょう。反映まで時間がかかるのか不明ですが、 時間が解決してくれたはたまにあります( ゚д゚)ナンデナン もし原因や解決法が分かった時は、コメント頂けたら幸いです! 同様の症状に悩む方の為に記事の更新を行います。 (ユーザー名とメールの再登録は不要だと思いますが、うまくいかない時はそこからやるのもありです)削除しないで更新する方法 → 2021年9月17日追記
キーチェーンアクセスからパスワードの更新もできたので、追記します。
パスワードを表示のチェックボックスをクリックすると、パスワードを求められます。
ここのパスワードはMacにログインするときのパスワードと同じでした。
また、下記PASSも求められる場合があります。(画像はSourceTreeのキーチェーン情報です)
アクセス許可が済むと、
現在設定しているPATが表示されるので、
そこを書き直して変更内容を保存します。
その後プッシュした際にアクセス許可を再度求められます。
SouceTreeについてはアクセス許可と再度PATを入力する必要が出るので、
作業量にあまり差がないです。
方法がいくつかあるということだけ覚えておいてください。
■Windousユーザー
windowsを使用していないので実施検証できておらず詳細不明ですが、
暫定で以下記事を参考に実施してみてください。
この記事でできたヨ!みたいな連絡貰えると嬉しいです!
余談
PAT(パーソナルアクセストークン)って略して記述してある記事もあるけど、略語って事前に略しますって宣言されてないと初めて読むときに面倒だなとちょっと思いました。
JSやCSSで命名するときは略語を使いすぎないよう気をつけようとも改めて思いました。
また、git config --global でユーザー名やメールの再登録をしている記事がありましたが、
キーチェーンの削除をしてもgitconfigに記述されているものは削除されませんでしたので、
再度コマンドを打つ必要はないんじゃないかなと思いました。
キーチェーンの削除はあくまでパスワードの削除のみ、ということになります。
ただ、全体のリポジトリでユーザー名やメールの登録をし直したい場合は、必要でしょう。
最後に
以上、パーソナルアクセストークンの更新についてのまとめとなります。
エラーが出た時がなんだかんだ一番楽しいかもしれないと感じた筆者でした( ˘ω˘ )エラーカイケツガスッキ
あとGitHub blogsやGitHub Docsを見るのも楽しいです!
上手くいかない時はエラーで検索、ドキュメントを読むなどの他、twitterで事象が全体で起きているのか他に同じことで悩んでいる人がいないか調べるのもいいです。解決策あったりなかったり。
参考記事
Token authentication requirements for API and Git operations
[GitHub] Personal Access Tokenの有効期限を設定できるようになっていました
【突然GitHubにpushできなくなった】 トークン生成で解決:The requested URL returned error: 403
Github公式ドキュメント 個人アクセストークンを使用する