TwitterAPIのリクエストトークン ・リクエストトークンシークレットを取得したいです。

Question

前提・実現したいこと

Swiftを勉強し始めて３ヶ月目に入ったところの初心者です。

フレームワーク・ライブラリに頼らずTwitterAPIを叩いてユーザーに認証してもらい、ユーザーがツイートできるTwitterクライアントアプリを作ろうとしています。

ここに質問の内容を詳しく書いてください。
（例）PHP(CakePHP)で●●なシステムを作っています。

最初のリクエストトークン・リクエストトークンシークレットを取得する所で躓いています。
おそらく署名がおかしいのではないかと思うのですが、どのように直せば良いのかが分からずに困っています。

正しくリクエストの結果を得るにはどうすれば良いか、ご教示いただきたいと思います。

■■な機能を実装中に以下のエラーメッセージが発生しました。

Postでエンドポイントにリクエストを送った所でレスポンスが以下のようなエラーになってしまいます。

発生している問題・エラーメッセージ

Optional("{\"errors\":[{\"code\":32,\"message\":\"Could not authenticate you.\"}]}")

該当のソースコード

import UIKit
import CommonCrypto// <------ HMAC-SHA1方式のハッシュ値を作る際に使いました。

class ViewController: UIViewController {

    
    @IBOutlet weak var tweetTextView: UITextView!
 
    override func viewDidLoad() {
        super.viewDidLoad()
        
        let nonce = (NSUUID().uuidString as NSString).substring(to: 8)
        let stamp = String(Int64(NSDate().timeIntervalSince1970))
        // 設定項目
        let api_key = "xxxxxxxxxxxxxxxxxxxxxxxxx" ;    // API Key
        let api_secret = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" ;    // API Secret
        let callback_url = "swifter-xxxxxxxxxxxxxxxxxxxxxxxxx://" ;    // Callback URL (このプログラムのURLアドレス(以前Swifterを使ってアプリを作ったことがあり、そのままにしています。))
        
        // [アクセストークンシークレット] (まだ存在しないので「なし」)
        let access_token_secret = ""

        // エンドポイントURL
        let request_url = "https://api.twitter.com/oauth/request_token"

        // リクエストメソッド
        let request_method = "POST" ;

        // キーを作成する (URLエンコードする)
        let api_secret_encode = urlEncode(beforeText: api_secret)
        let access_token_secret_encode = urlEncode(beforeText: access_token_secret)

        let signature_key = api_secret_encode + "&" + access_token_secret_encode
        
        var params = [
            "oauth_callback": callback_url,
            "oauth_consumer_key": api_key,
            "oauth_nonce": nonce,
            "oauth_signature_method": "HMAC-SHA1",
            "oauth_timestamp": stamp,
            "oauth_version": "1.0",
        ]

        let oauth_consumer_key = urlEncode(beforeText: api_key)
        let oauth_nonce = urlEncode(beforeText: nonce)
        let oauth_signature_method = urlEncode(beforeText: "HMAC-SHA1")
        let oauth_timestamp = urlEncode(beforeText: stamp)
        let oauth_version = urlEncode(beforeText: "1.0")
        
        // パラメータの連想配列を[キー=値&キー=値...]の文字列に変換する
        let request_params = "oauth_callback=\(callback_url)&oauth_consumer_key=\(oauth_consumer_key)&oauth_nonce=\(oauth_nonce)&oauth_signature_method=\(oauth_signature_method)&oauth_timestamp=\(oauth_timestamp)&oauth_version=\(oauth_version)"
        
        // 変換した文字列をURLエンコードする
        let request_params_encode = urlEncode(beforeText: request_params)
        
        // リクエストメソッドをURLエンコードする
        let request_method_encode = urlEncode(beforeText: request_method)
        
        // リクエストURLをURLエンコードする
        let request_url_encode = urlEncode(beforeText: request_url)
        
        // リクエストメソッド、リクエストURL、パラメータを[&]で繋ぐ
        let signature_data = request_method_encode + "&" + request_url_encode + "&" + request_params_encode
        
        // キー[$signature_key]とデータ[$signature_data]を利用して、HMAC-SHA1方式のハッシュ値に変換する
        let hash = signature_data.hmac(key: signature_key)
        
        // base64エンコードして、署名[$signature]が完成する
        let signature = hash.data(using: .utf8)?.base64EncodedString()
                 
        let signature_encode = urlEncode(beforeText: signature!)
        // パラメータの連想配列、[$params]に、作成した署名を加える
        params["oauth_signature"] = signature_encode

        let callback_url_encode = urlEncode(beforeText: callback_url)
        
        let request_params_with_signature = "oauth_consumer_key=\(oauth_consumer_key),oauth_signature_method=\(oauth_signature_method),oauth_timestamp=\(oauth_timestamp),oauth_nonce=\(oauth_nonce),oauth_version=\(oauth_version),oauth_callback=\(callback_url_encode),oauth_signature=\(String(signature_encode))"
 
        let urlComponents = URLComponents(string: request_url)!  //URLComponentsでURLを生成
        var request = URLRequest(url: urlComponents.url!)
        request.httpMethod = "POST"      // Postリクエストを送る(このコードがないとGetリクエストになる)
        request.allHTTPHeaderFields! = ["Authorization": "OAuth " + request_params_with_signature]
        print(request.allHTTPHeaderFields!)
        let task = URLSession.shared.dataTask(with: request) { (data, response, error) in
            guard let data = data else { return }
            let str: String? = String(data: data, encoding: .utf8)
            print(str)
        }
        task.resume()
    }
    
    func urlEncode(beforeText: String) -> String {
        // RFC3986 に準拠
        // 変換対象外とする文字列（英数字と-._~）
        let allowedCharacters = NSCharacterSet.alphanumerics.union(.init(charactersIn: "-._~"))
            
        if let encodedText = beforeText.addingPercentEncoding(withAllowedCharacters: allowedCharacters) {
            return encodedText
        }
        print("encode error")
        return ""
    }
}

extension String {

    func hmac(key: String) -> String {
        var digest = [UInt8](repeating: 0, count: Int(CC_SHA1_DIGEST_LENGTH))
        CCHmac(CCHmacAlgorithm(kCCHmacAlgSHA1), key, key.count, self, self.count, &digest)
        let data = Data(_: digest)
        return data.map { String(format: "%02hhx", $0) }.joined()
    }

}

試したこと

ここに問題に対して試したことを記載してください。

SyncerJP（https://syncer.jp/Web/API/Twitter/REST_API/#section-2-3 ）というサイトを参考にしながらコードを書いてみたのですが、例文がSwiftではなくPHPで、PHPはサッパリ分からないためどこをどう直せば良いか分かりません。

他にも「TwitterAPI ツイート 投稿」などで検索したのですが、フレームワークを使っている例文が多く、またその記事も古いせいか参考にはなりませんでした。

PostmanでAPIキーなどを入力して、正しいレスポンスを得られた時のリクエストヘッダーを参考にどこが悪いのか探ったのですが、どうもSyncerのPHPの例文で言う所の「$signature」、つまり署名（？）がPostmanで得られたものよりも倍近く長いのがいけないのではないかと言うところまでは分かったのですが、どのように直せば良いのかが分からずにいます。

・・・追記
OAuthSwiftを使うと良いと言う修正依頼を頂いたので試してみたのですが、

import UIKit
import OAuthSwift

class ViewController: UIViewController {
    // create an instance and retain it
    var oauthswift = OAuth1Swift(
        consumerKey:    "xxxxxxxxxxxxxxxxxxxxxxxxx",
        consumerSecret: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        requestTokenUrl: "https://api.twitter.com/oauth/request_token",
        authorizeUrl:    "https://api.twitter.com/oauth/authorize",
        accessTokenUrl:  "https://api.twitter.com/oauth/access_token"
    )
    
    override func viewDidLoad() {
        super.viewDidLoad()
        // authorize
        _ = oauthswift.authorize(
            withCallbackURL: "swifter-xxxxxxxxxxxxxxxxxxxxxxxxx://") { result in
            switch result {
            case .success(let (credential, _, _)):
              print(credential.oauthToken)
              print(credential.oauthTokenSecret)
              // Do your request
            case .failure(let error):
              print(error.localizedDescription)
            }
        }
    }
}

・・・でログインできたのですが、コンソールには何もprintされず、リクエストトークン もリクエストトークン シークレットも得られない状態です。ちなみにログイン画面はSafariになっています。

補足情報（FW/ツールのバージョンなど）

ここにより詳細な情報を記載してください。

Xcode11.6
iPhoneSE
iOS13.6

Comments

[Tomato45]

CommonCryptoは何のためのものですか？自分がTwitterKitを2019年4月の中旬に試したときはそんなものは使ってません。きっとOAuthSwiftを使ってやれば、簡単にできると思いますっけど。TwitterKitを使った時もUIKitとTwitterKitを使っただけでちゅ。

[tmyk1979]

CommonCryptoはHMAC-SHA1方式のハッシュ値を作る際に使ったものです。
TwitterKitかOAuthSwift・・・ネットに載っている例文が古くエラーや警告に対応できなかったため敬遠していたのですが、もう一度やってみます。

アドバイスありがとうございます。

[tmyk1979]

https://swiftobc-com.translate.goog/repo/OAuthSwift-OAuthSwift-swift-authentication?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja&_x_tr_pto=op,sc
・・・を参考にOAuthSwiftを使ったところ、言われた通り簡単にログインできました。
ただ、アクセストークン ・アクセストークン シークレットどころか、コンソールには何もprintされませんでした。

https://qiita.com/haru15komekome/items/10bd68df52ad72233b5c
・・・を参考にやってみたところ、やはりログインはできたのですが、
ただ、リクエストトークン・リクエストシークレットがprintされず、Safari presentedとprintされてしまい、アプリに戻ってくることができませんでした。

[Tomato45]

「...を参考にやってみた」、というのは誰かにそれらのサイトに言って、何がおかしいのかを確認して欲しい、ということですか？自分がOAuthSwiftを使ってTwitter APIを試したのはほぼ3年前でっけど、その時のコードを見る限り、問題があった、という表記はないので、自分には詳しいことはわかりまへん。

[tmyk1979]

初心者にとっては参考サイトの記事を読んだり例文を写経するくらいの事しかできず、記事も古いものが多いため例文もエラーや警告が出る事がほとんどで、そのまま写経したら動いたと言うことは稀です。

「。。。を参考にやってみた」と言うのはサイトに行って何がおかしいのか確認してほしいと言うわけではなく、参考にやってみたところ、（今回は）エラーも警告も出ないけど思った内容がprintされないのが何故か分からないので教えていただきたいと言う意味でした。

TwitterKitはもうサポート終了していますし、OAuthSwiftも試してはいましたがうまく行かなかったので、どうせならそれらに頼らずTwitterAPIを叩けるようになりたいと思い、質問文にも「フレームワークやライブラリに頼らず」と書いたのですが、OAuthSwiftなら簡単とのアドバイスだったのでもう一度試してみようと思った次第です。

なお、Swifterで試してみたところリクエストトークン・シークレットを飛び越してアクセストークン ・シークレットが得られました。目的は果たせるしこれでも良いかなと思うのでこれから自己解決を書こうと思います。

Tomato45さんのアドバイスが無ければSwifterも試していなかったかも知れません。
アドバイスをいただき感謝しています。ありがとうございました。

Answer 1

Swifterを使ったところ、リクエストトークン ・リクエストトークンシークレットを飛び越してアクセストークン・アクセストークンシークレットを得られたので、これで良しとします。

import UIKit
import SafariServices
import Swifter

class ViewController: UIViewController, SFSafariViewControllerDelegate {

    let swifter = Swifter(
        consumerKey: "xxxxxxxxxxxxxxxxxxxxxxxxx",
        consumerSecret: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    )

    override func viewDidLoad() {
        super.viewDidLoad()
        print("start")
        
        swifter.authorize(
            withCallback: URL(string: "swifter-xxxxxxxxxxxxxxxxxxxxxxxxx://")!,
            presentingFrom: self,
            success: { accessToken, response in
                guard let accessToken = accessToken else {
                    return
                }
                let oAuthToken = accessToken.key
                let secret = accessToken.secret
                let userID = accessToken.userID
                let screenName = accessToken.screenName
                print(oAuthToken)
                print(secret)
                print(userID!)
                print(screenName!)
        }, failure: { error in
            print(error)
        })
    }
}

なお、https://qiita.com/kboy/items/c83a0505d12cc8e7d4b9 を参考にしました。

iOS13以降はSceneDelegate.swiftにも手直しが必要との事。
(引用元の記事へのリンクがうまく貼れませんでした。「【iOS13以降】Swifterを用いた際のcallback URLの記述場所はAppDelegateではない」で検索すれば下記引用元も探せると思います。「かずのアプリときどきキャンプ飯」と言うサイトです。)

引用テキスト

iOS13より前では、コールバックを受ける場合の処理はAppDelegateに

import Swifter

    func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
        return Swifter.handleOpenURL(url, callbackURL: URL(string: "swifter-{Consumer API key}://")!)
    }

と記載していれば良かったのですが、iOS13以降ではここは呼ばれません。

代わりに、ScheneDelegateに

import Swifter

    // callback urlの設定
    func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>){
        Swifter.handleOpenURL(URLContexts.first!.url, callbackURL: URL(string: "swifter-<ConsumerAPIkey>://")!)
    }

と記載する必要があるので要注意です。

・・・・・アドバイスを頂いたTomato45さんにベストアンサーを付けたい所なのですが、回答ではなく修正依頼のため付けられませんでした。重ねてお礼申し上げます。ありがとうございました。・・・・・

Comments

[Tomato45]

よく頑張りましたね。自分は特に何もしていません。うまくいったのも皆んなの意見を聞きながら独りで努力したあなたが頑張った結果です。