مشكلات ترخيص OAuth 1.0 مع X API v2 في Scala عبر STTP

حل تفويض OAuth 1.0 باستخدام Scala وSTTP لواجهة برمجة تطبيقات Twitter

يوضح هذا البرنامج النصي كيفية تسجيل طلبات OAuth 1.0 في Scala باستخدام HMAC-SHA1. فهو يضمن النمطية ومعالجة الأخطاء، مما يؤدي إلى كود قابل لإعادة الاستخدام وقابل للصيانة.

import java.net.URLEncoder
import javax.crypto.Mac
import javax.crypto.spec.SecretKeySpec
import org.joda.time.DateTime
import sttp.client4._
import sttp.model.Header
import scala.util.Random
object Auth {
  def urlEncode(text: String): String =
    URLEncoder.encode(text, java.nio.charset.Charset.defaultCharset())
  def generateNonce: String = Random.alphanumeric.take(15).mkString
  def sha1sign(text: String, key: String): String = {
    val mac = Mac.getInstance("HmacSHA1")
    val signingKey = new SecretKeySpec(key.getBytes, "HmacSHA1")
    mac.init(signingKey)
    val signature = mac.doFinal(text.getBytes("UTF-8"))
    java.util.Base64.getEncoder.encodeToString(signature)
  }
  def createHeader(authData: Map[String, String]): Header = {
    val signatureBaseString = "POST&" + urlEncode("https://api.twitter.com/2/tweets") + "&" +
      urlEncode(authData.toSeq.sorted.map(x => s"${x._1}=${x._2}").mkString("&"))
    val signature = sha1sign(signatureBaseString, "consumerSecret&tokenSecret")
    val authHeader = "OAuth " + authData.map { case (k, v) => s"""$k="${urlEncode(v)}"""" }.mkString(", ") +
      s""", oauth_signature="${urlEncode(signature)}""""
    Header("Authorization", authHeader)
  }
}
object TwitterApi {
  val postEndpoint = "https://api.twitter.com/2/tweets"
  def createPost(text: String): Response = {
    val authData = Map(
      "oauth_consumer_key" -> "yourConsumerKey",
      "oauth_nonce" -> Auth.generateNonce,
      "oauth_signature_method" -> "HMAC-SHA1",
      "oauth_timestamp" -> DateTime.now().getMillis.toString,
      "oauth_token" -> "yourToken",
      "oauth_version" -> "1.0"
    )
    val header = Auth.createHeader(authData)
    basicRequest
      .header(header)
      .contentType("application/json")
      .body(s"""{"text":"$text"}""")
      .post(uri"$postEndpoint")
      .send(backend)
  }
}

النهج البديل: OAuth 1.0 مع معالجة Nonce والطابع الزمني المخصصة

تعمل هذه الطريقة على تبسيط عملية التوقيع من خلال التركيز على إنشاء أرقام وطوابع زمنية مخصصة مع الحد الأدنى من التبعيات.

import java.net.URLEncoder
import javax.crypto.Mac
import javax.crypto.spec.SecretKeySpec
import sttp.client4._
import sttp.model.Header
object OAuthHelper {
  def generateTimestamp: String = (System.currentTimeMillis / 1000).toString
  def generateNonce: String = java.util.UUID.randomUUID().toString.replace("-", "")
  def urlEncode(value: String): String = URLEncoder.encode(value, "UTF-8")
  def hmacSha1(baseString: String, key: String): String = {
    val mac = Mac.getInstance("HmacSHA1")
    val signingKey = new SecretKeySpec(key.getBytes("UTF-8"), "HmacSHA1")
    mac.init(signingKey)
    val rawHmac = mac.doFinal(baseString.getBytes("UTF-8"))
    java.util.Base64.getEncoder.encodeToString(rawHmac)
  }
}
object TwitterClient {
  def createAuthorizationHeader(params: Map[String, String], signature: String): Header = {
    val headerParams = params.map { case (k, v) => s"""$k="${OAuthHelper.urlEncode(v)}"""" }.mkString(", ")
    Header("Authorization", s"""OAuth $headerParams, oauth_signature="$signature"""")
  }
  def postTweet(text: String): Response = {
    val params = Map(
      "oauth_consumer_key" -> "consumerKey",
      "oauth_nonce" -> OAuthHelper.generateNonce,
      "oauth_signature_method" -> "HMAC-SHA1",
      "oauth_timestamp" -> OAuthHelper.generateTimestamp,
      "oauth_token" -> "accessToken",
      "oauth_version" -> "1.0"
    )
    val baseString = "POST&" + OAuthHelper.urlEncode("https://api.twitter.com/2/tweets") + "&" +
      OAuthHelper.urlEncode(params.toSeq.sorted.map { case (k, v) => s"$k=$v" }.mkString("&"))
    val signature = OAuthHelper.hmacSha1(baseString, "consumerSecret&tokenSecret")
    val authHeader = createAuthorizationHeader(params, signature)
    basicRequest
      .header(authHeader)
      .contentType("application/json")
      .body(s"""{"text":"$text"}""")
      .post(uri"https://api.twitter.com/2/tweets")
      .send(backend)
  }
}

الأسئلة المتداولة حول OAuth 1.0 ومصادقة Twitter API

1. كيف يختلف OAuth 1.0 عن OAuth 2.0؟
2. يستخدم OAuth 1.0 التوقيعات وتشفير HMAC-SHA1 للأمان، بينما يستخدم OAuth 2.0 التفويض المستند إلى الرمز المميز، مما يبسط العملية ولكنه يتطلب اتصالات HTTPS آمنة.
3. ما هو الغرض من nonce في OAuth 1.0؟
4. لمنع هجمات إعادة التشغيل، يقوم كل طلب بإنشاء سلسلة فريدة تُعرف باسم nonce. يضمن تنفيذ كل طلب مرة واحدة فقط. Scala يسمح لك ببناء nonce باستخدام Random.alphanumeric.take().
5. لماذا يعد ترميز URL ضروريًا في طلبات OAuth؟
6. يعد تشفير عنوان URL أمرًا بالغ الأهمية نظرًا لأنه يجب ترميز أحرف معينة، مثل علامات الضم (&) أو المسافات، لتجنب التفسير الخاطئ. يستخدم URLEncoder.encode() لتشفير هذه الأحرف بأمان.
7. كيف أقوم بإنشاء توقيع OAuth؟
8. لإنشاء توقيع OAuth، قم أولاً بإنشاء سلسلة أساسية من بيانات الطلب ثم قم بتوقيعها باستخدام تقنية HMAC-SHA1. يستخدم Mac.getInstance("HmacSHA1") لبدء عملية التجزئة.
9. ما الذي يمكن أن يسبب خطأ 401 غير مصرح به في OAuth؟
10. يمكن أن يحدث خطأ 401 بسبب مجموعة متنوعة من الأخطاء، بما في ذلك التوقيع غير الصالح أو مفاتيح المستهلك غير المتطابقة أو ترميز المعلمات غير المناسب. تأكد دائمًا من مطابقة التوقيع لبيانات الطلب وأن التشفير دقيق.

الأفكار النهائية حول حل مشكلات Twitter OAuth

لتخويل طلب OAuth 1.0 لواجهة برمجة تطبيقات Twitter بشكل صحيح، يجب على المطورين إدارة التوقيعات والعناوين بعناية. تحدث العديد من المشكلات بسبب مشكلات الترميز أو استخدام تنسيق السلسلة الأساسية غير الصحيح. يمكن منع حدوث أخطاء مثل "401 غير مصرح به" عن طريق معالجة هذه المشكلات بشكل مناسب.

علاوة على ذلك، فإن إعادة التحقق من إنشاء nonce ودقة الطابع الزمني وتنسيق الرأس يزيد بشكل كبير من نجاح التفويض. يعد تحسين طريقة sha1sign، وضمان حساب التوقيع الدقيق، والالتزام بمتطلبات OAuth مراحل حاسمة نحو تطوير تطبيق نشر X وظيفي وآلي.