unidocs/org.http4s.client.oauth1

org.http4s.client.oauth1

package org.http4s.client.oauth1

Basic OAuth1 message signing support

This feature is not considered stable.

Type members

Classlikes

final case class Consumer(key: String, secret: String)

Representation of a Consumer key and secret

Representation of a Consumer key and secret

Source:
Types.scala
object HmacSha1 extends SignatureAlgorithm

An implementation of the HMAC-SHA1 oauth signature method.

An implementation of the HMAC-SHA1 oauth signature method.

This uses the HmacSHA1 implementation which every java platform is required to have.

Source:
SignatureAlgorithm.scala
object HmacSha256 extends SignatureAlgorithm

An implementation of the HMAC-SHA256 oauth signature method.

An implementation of the HMAC-SHA256 oauth signature method.

This uses the HmacSHA256 implementation which every java platform is required to have.

Source:
SignatureAlgorithm.scala
object HmacSha512 extends SignatureAlgorithm

An implementation of the HMAC-SHA512 oauth signature method.

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)

Source:
SignatureAlgorithm.scala
sealed trait ProtocolParameter
object ProtocolParameter
object SignatureAlgorithm
trait SignatureAlgorithm

Implementations for Oauth1 signatures.

Implementations for Oauth1 signatures.

Companion:
object
Source:
SignatureAlgorithm.scala
final case class Token(value: String, secret: String)

Representation of an OAuth Token and Token secret

Representation of an OAuth Token and Token secret

Source:
Types.scala

Value members

Concrete methods

def mkBaseString(method: Method, uri: Uri, paramsStr: String): String
def signRequest[F[_]](req: Request[F], consumer: Consumer, token: Option[Token], realm: Option[Realm], signatureMethod: SignatureMethod, timestampGenerator: F[Timestamp], version: Version, nonceGenerator: F[Nonce], callback: Option[Callback], verifier: Option[Verifier])(implicit F: MonadThrow[F], W: EntityDecoder[F, UrlForm]): F[Request[F]]
def takeSigHeaders[F[_] : Monad](consumer: Consumer, token: Option[Token], signatureMethod: SignatureMethod, timestampGenerator: F[Timestamp], version: Version, nonceGenerator: F[Nonce], callback: Option[Callback], verifier: Option[Verifier]): F[Seq[ProtocolParameter]]

Deprecated methods

@deprecated("Preserved for binary compatibility - use the other `signRequest` function which passes a signature method", "0.22.3")
def signRequest[F[_]](req: Request[F], consumer: Consumer, callback: Option[Uri], verifier: Option[String], token: Option[Token])(implicit F: MonadThrow[F], W: EntityDecoder[F, UrlForm]): F[Request[F]]

Sign the request with an OAuth Authorization header

Sign the request with an OAuth Authorization header

WARNING: POST requests with application/x-www-form-urlencoded bodies will be entirely buffered due to signing requirements.

Deprecated
Source:
oauth1.scala