scram_client.go

Copyright 2024 Red Hat, Inc

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
kafka
import
"github.com/xdg/scram"

SCRAMClient implementation for the SCRAM authentication

type
SCRAMClient
struct
{
*
scram
.
Client
*
scram
.
ClientConversation
scram
.
HashGeneratorFcn
}

Begin prepares the client for the SCRAM exchange

func
(
x
*
SCRAMClient
)
Begin
(
userName
,
password
,
authzID
string
)
(
err
error
)
{
x
.
Client
,
err
=
x
.
HashGeneratorFcn
.
NewClient
(
userName
,
password
,
authzID
)
if
err
!=
nil
{
return
err
}
x
.
ClientConversation
=
x
.
Client
.
NewConversation
(
)
return
nil
}

Step steps client through the SCRAM exchange

func
(
x
*
SCRAMClient
)
Step
(
challenge
string
)
(
response
string
,
err
error
)
{
response
,
err
=
x
.
ClientConversation
.
Step
(
challenge
)
return
}

Done should return true when the SCRAM conversation is over.

func
(
x
*
SCRAMClient
)
Done
(
)
bool
{
return
x
.
ClientConversation
.
Done
(
)
}