org.http4s.client.oauth1.SignatureAlgorithm.scala Maven / Gradle / Ivy
/*
* Copyright 2014 http4s.org
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.http4s.client.oauth1
import cats.MonadThrow
import cats.effect.SyncIO
import cats.syntax.all._
import org.http4s.client.oauth1.ProtocolParameter.SignatureMethod
import org.http4s.client.oauth1.SignatureAlgorithm.Names._
import org.http4s.crypto.Hmac
import org.http4s.crypto.HmacAlgorithm
import org.http4s.crypto.SecretKeySpec
import scodec.bits.ByteVector
import scala.annotation.nowarn
object SignatureAlgorithm {
private[oauth1] object Names {
// algorithms implemented so far
val `HMAC-SHA1` = "HMAC-SHA1"
val `HMAC-SHA256` = "HMAC-SHA256"
val `HMAC-SHA512` = "HMAC-SHA512"
// other known algorithms (not yet implemented)
val PLAINTEXT = "PLAINTEXT"
val `RSA-SHA1` = "RSA-SHA1"
val `RSA-SHA256` = "RSA-SHA256"
val `RSA-SHA512` = "RSA-SHA512"
}
private[this] val AllMethods = List(HmacSha1, HmacSha256, HmacSha512)
/** Map a [[SignatureMethod]] protocol parameter to a [[SignatureAlgorithm]] implementation
*
* @param method The signature method protocol parameter
* @return The implementation, or an [[IllegalArgumentException]] if none was found
*/
private[oauth1] def unsafeFromMethod(method: SignatureMethod): SignatureAlgorithm =
AllMethods
.find(_.name == method.headerValue)
.getOrElse(
throw new IllegalArgumentException(
s"Unrecognized headerValue '${method.headerValue}', Valid options are: ${AllMethods.map(_.name)}"
)
)
}
/** Implementations for Oauth1 signatures.
*/
trait SignatureAlgorithm {
/** @return The signature method name per the oauth1.0 spec
*/
def name: String
/** Apply the implementation's algorithm to the input
*
* @param input The input value
* @param secretKey The secret key
* @return The base64-encoded output
*/
def generate[F[_]: MonadThrow](input: String, secretKey: String): F[String] =
MonadThrow[F].catchNonFatal(generate(input, secretKey): @nowarn("cat=deprecation"))
@deprecated("Use generate[F[_]: MonadThrow] instead", "0.22.5")
def generate(input: String, secretKey: String): String =
generate[SyncIO](input, secretKey).unsafeRunSync()
private[oauth1] def generateHMAC[F[_]: MonadThrow: Hmac](
input: String,
algorithm: HmacAlgorithm,
secretKey: String,
): F[String] =
for {
keyData <- ByteVector.encodeUtf8(secretKey).liftTo[F]
sk = SecretKeySpec(keyData, algorithm)
data <- ByteVector.encodeUtf8(input).liftTo[F]
digest <- Hmac[F].digest(sk, data)
} yield digest.toBase64
}
/** An implementation of the `HMAC-SHA1` oauth signature method.
*
* This uses the `HmacSHA1` implementation which every java platform is required to have.
*/
object HmacSha1 extends SignatureAlgorithm {
override val name: String = `HMAC-SHA1`
override def generate[F[_]: MonadThrow](input: String, secretKey: String): F[String] =
generateHMAC(input, HmacAlgorithm.SHA1, secretKey)
}
/** An implementation of the `HMAC-SHA256` oauth signature method.
*
* This uses the `HmacSHA256` implementation which every java platform is required to have.
*/
object HmacSha256 extends SignatureAlgorithm {
override val name: String = `HMAC-SHA256`
override def generate[F[_]: MonadThrow](input: String, secretKey: String): F[String] =
generateHMAC(input, HmacAlgorithm.SHA256, secretKey)
}
/** An implementation of the `HMAC-SHA512` oauth signature method.
*
* WARNING - This uses the `HmacSHA512` implementation which is *not* required to be present by the Java spec.
* (However, most modern Java runtimes tend to have it)
*/
object HmacSha512 extends SignatureAlgorithm {
override val name: String = `HMAC-SHA512`
override def generate[F[_]: MonadThrow](input: String, secretKey: String): F[String] =
generateHMAC(input, HmacAlgorithm.SHA512, secretKey)
}