TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-04-04 18:39:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a flag to imap settings to enable/disable oauth2 scheme

Browse Source
This commit is contained in:
Eike Kettner 2021-01-03 16:36:19 +01:00
parent ac6a7b28be
commit 0cfd8974d3
8 changed files with 69 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
modules/backend/src/main/scala/docspell/backend/ops/OMail.scala
View File

@ -123,7 +123,8 @@ object OMail {
imapUser: Option[String],
imapPassword: Option[Password],
imapSsl: SSLType,
imapCertCheck: Boolean
imapCertCheck: Boolean,
imapOAuth2: Boolean
) {
def toRecord(accId: AccountId) =
@ -135,7 +136,8 @@ object OMail {
imapUser,
imapPassword,
imapSsl,
imapCertCheck
imapCertCheck,
imapOAuth2
)
}

6
modules/restapi/src/main/resources/docspell-openapi.yml
View File

@ -3873,6 +3873,7 @@ components:
- from
- sslType
- ignoreCertificates
- useOAuth
properties:
name:
type: string
@ -3891,6 +3892,11 @@ components:
type: string
ignoreCertificates:
type: boolean
useOAuth:
type: boolean
description: |
Use the password as an OAuth2 access token with the
authentication scheme XOAUTH2.
CalEventCheckResult:
description: |
The result of checking a calendar event string.

6
modules/restserver/src/main/scala/docspell/restserver/routes/MailSettingsRoutes.scala
View File

@ -166,7 +166,8 @@ object MailSettingsRoutes {
ru.imapUser,
ru.imapPassword,
ru.imapSsl.name,
!ru.imapCertCheck
!ru.imapCertCheck,
ru.imapOAuth2
)
def makeSmtpSettings(ems: EmailSettings): Either[String, OMail.SmtpSettings] = {
@ -203,6 +204,7 @@ object MailSettingsRoutes {
ims.imapUser,
ims.imapPassword,
sslt,
!ims.ignoreCertificates
!ims.ignoreCertificates,
ims.useOAuth
)
}

7
modules/store/src/main/resources/db/migration/h2/V1.16.0__add_imap_oauth.sql Normal file
View File

@ -0,0 +1,7 @@
ALTER TABLE "userimap"
ADD COLUMN "imap_oauth2" boolean NULL;
UPDATE "userimap" SET "imap_oauth2" = false;
ALTER TABLE "userimap"
ALTER COLUMN "imap_oauth2" SET NOT NULL;

7
modules/store/src/main/resources/db/migration/mariadb/V1.16.0__add_imap_oauth.sql Normal file
View File

@ -0,0 +1,7 @@
ALTER TABLE `userimap`
ADD COLUMN (`imap_oauth2` boolean);
UPDATE `userimap` SET `imap_oauth2` = false;
ALTER TABLE `userimap`
MODIFY `imap_oauth2` boolean NOT NULL;

7
modules/store/src/main/resources/db/migration/postgresql/V1.16.0__add_imap_oauth.sql Normal file
View File

@ -0,0 +1,7 @@
ALTER TABLE "userimap"
ADD COLUMN "imap_oauth2" boolean NULL;
UPDATE "userimap" SET "imap_oauth2" = false;
ALTER TABLE "userimap"
ALTER COLUMN "imap_oauth2" SET NOT NULL;

17
modules/store/src/main/scala/docspell/store/records/RUserImap.scala
View File

@ -22,6 +22,7 @@ case class RUserImap(
imapPassword: Option[Password],
imapSsl: SSLType,
imapCertCheck: Boolean,
imapOAuth2: Boolean,
created: Timestamp
) {
@ -32,6 +33,7 @@ case class RUserImap(
imapUser.getOrElse(""),
imapPassword.map(_.pass).getOrElse(""),
imapSsl,
imapOAuth2,
!imapCertCheck
)
}
@ -47,7 +49,8 @@ object RUserImap {
imapUser: Option[String],
imapPassword: Option[Password],
imapSsl: SSLType,
imapCertCheck: Boolean
imapCertCheck: Boolean,
imapOAuth2: Boolean
): F[RUserImap] =
for {
now <- Timestamp.current[F]
@ -62,6 +65,7 @@ object RUserImap {
imapPassword,
imapSsl,
imapCertCheck,
imapOAuth2,
now
)
@ -73,7 +77,8 @@ object RUserImap {
imapUser: Option[String],
imapPassword: Option[Password],
imapSsl: SSLType,
imapCertCheck: Boolean
imapCertCheck: Boolean,
imapOAuth2: Boolean
): OptionT[ConnectionIO, RUserImap] =
for {
now <- OptionT.liftF(Timestamp.current[ConnectionIO])
@ -89,6 +94,7 @@ object RUserImap {
imapPassword,
imapSsl,
imapCertCheck,
imapOAuth2,
now
)
@ -104,6 +110,7 @@ object RUserImap {
val imapPass = Column[Password]("imap_password", this)
val imapSsl = Column[SSLType]("imap_ssl", this)
val imapCertCheck = Column[Boolean]("imap_certcheck", this)
val imapOAuth2 = Column[Boolean]("imap_oauth2", this)
val created = Column[Timestamp]("created", this)
val all = NonEmptyList.of[Column[_]](
@ -116,6 +123,7 @@ object RUserImap {
imapPass,
imapSsl,
imapCertCheck,
imapOAuth2,
created
)
}
@ -129,7 +137,7 @@ object RUserImap {
.insert(
t,
t.all,
sql"${v.id},${v.uid},${v.name},${v.imapHost},${v.imapPort},${v.imapUser},${v.imapPassword},${v.imapSsl},${v.imapCertCheck},${v.created}"
sql"${v.id},${v.uid},${v.name},${v.imapHost},${v.imapPort},${v.imapUser},${v.imapPassword},${v.imapSsl},${v.imapCertCheck},${v.imapOAuth2},${v.created}"
)
}
@ -145,7 +153,8 @@ object RUserImap {
t.imapUser.setTo(v.imapUser),
t.imapPass.setTo(v.imapPassword),
t.imapSsl.setTo(v.imapSsl),
t.imapCertCheck.setTo(v.imapCertCheck)
t.imapCertCheck.setTo(v.imapCertCheck),
t.imapOAuth2.setTo(v.imapOAuth2)
)
)
}

23
modules/webapp/src/main/elm/Comp/ImapSettingsForm.elm
View File

@ -32,6 +32,7 @@ type alias Model =
, password : Maybe String
, sslType : Comp.Dropdown.Model SSLType
, ignoreCertificates : Bool
, useOAuthToken : Bool
}
@ -58,6 +59,7 @@ emptyModel =
, selected = Just Data.SSLType.None
}
, ignoreCertificates = False
, useOAuthToken = False
}
@ -87,6 +89,7 @@ init ems =
|> Just
}
, ignoreCertificates = ems.ignoreCertificates
, useOAuthToken = ems.useOAuth
}
@ -104,6 +107,7 @@ getSettings model =
|> Maybe.withDefault Data.SSLType.None
|> Data.SSLType.toString
, ignoreCertificates = model.ignoreCertificates
, useOAuth = model.useOAuthToken
}
)
@ -116,6 +120,7 @@ type Msg
| PassMsg Comp.PasswordInput.Msg
| SSLTypeMsg (Comp.Dropdown.Msg SSLType)
| ToggleCheckCert
| ToggleUseOAuth
isValid : Model -> Bool
@ -159,14 +164,17 @@ update msg model =
ToggleCheckCert ->
( { model | ignoreCertificates = not model.ignoreCertificates }, Cmd.none )
ToggleUseOAuth ->
( { model | useOAuthToken = not model.useOAuthToken }, Cmd.none )
view : UiSettings -> Model -> Html Msg
view settings model =
div
[ classList
[ ( "ui form", True )
, ( "error", not (isValid model) )
, ( "success", isValid model )
, ( "info error", not (isValid model) )
, ( "info success", isValid model )
]
]
[ div [ class "required field" ]
@ -227,6 +235,17 @@ view settings model =
, label [] [ text "Ignore certificate check" ]
]
]
, div [ class "inline field" ]
[ div [ class "ui checkbox" ]
[ input
[ type_ "checkbox"
, checked model.useOAuthToken
, onCheck (\_ -> ToggleUseOAuth)
]
[]
, label [] [ text "Enable OAuth2 authentication using the password as access token" ]
]
]
]
, div [ class "two fields" ]
[ div [ class "field" ]