File: README

package info (click to toggle)
libauthen-scram-perl 0.011-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 244 kB
  • sloc: perl: 813; makefile: 7
file content (124 lines) | stat: -rw-r--r-- 3,193 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
NAME
    Authen::SCRAM - Salted Challenge Response Authentication Mechanism (RFC
    5802)

VERSION
    version 0.011

SYNOPSIS
        use Authen::SCRAM::Client;
        use Authen::SCRAM::Server;
        use Try::Tiny;

        ### CLIENT SIDE ###

        $client = Authen::SCRAM::Client->new(
            username => 'johndoe',
            password => 'trustno1',
        );

        try {
            $client_first = $client->first_msg();

            # send to server and get server-first-message

            $client_final = $client->final_msg( $server_first );

            # send to server and get server-final-message

            $client->validate( $server_final );
        }
        catch {
            die "Authentication failed!"
        };

        ### SERVER SIDE ###

        $server = Authen::SCRAM::Server->new(
            credential_cb => \&get_credentials,
        );

        $username = try {
            # get client-first-message

            $server_first = $server->first_msg( $client_first );

            # send to client and get client-final-message

            $server_final = $server->final_msg( $client_final );

            # send to client

            return $server->authorization_id; # returns valid username
        }
        catch {
            die "Authentication failed!"
        };

DESCRIPTION
    The modules in this distribution implement the Salted Challenge Response
    Authentication Mechanism (SCRAM) from RFC 5802.

    See Authen::SCRAM::Client and Authen::SCRAM::Server for usage details.

NAME
    Authen::SCRAM - Salted Challenge Response Authentication Mechanism (RFC
    5802)

VERSION
    version 0.011

SUPPORT
  Bugs / Feature Requests
    Please report any bugs or feature requests through the issue tracker at
    <https://github.com/dagolden/Authen-SCRAM/issues>. You will be notified
    automatically of any progress on your issue.

  Source Code
    This is open source software. The code repository is available for
    public review and contribution under the terms of the license.

    <https://github.com/dagolden/Authen-SCRAM>

      git clone https://github.com/dagolden/Authen-SCRAM.git

AUTHOR
    David Golden <dagolden@cpan.org>

CONTRIBUTOR
    David Golden <xdg@xdg.me>

COPYRIGHT AND LICENSE
    This software is Copyright (c) 2014 by David Golden.

    This is free software, licensed under:

      The Apache License, Version 2.0, January 2004

SUPPORT
  Bugs / Feature Requests
    Please report any bugs or feature requests through the issue tracker at
    <https://github.com/dagolden/Authen-SCRAM/issues>. You will be notified
    automatically of any progress on your issue.

  Source Code
    This is open source software. The code repository is available for
    public review and contribution under the terms of the license.

    <https://github.com/dagolden/Authen-SCRAM>

      git clone https://github.com/dagolden/Authen-SCRAM.git

AUTHOR
    David Golden <dagolden@cpan.org>

CONTRIBUTOR
    David Golden <xdg@xdg.me>

COPYRIGHT AND LICENSE
    This software is Copyright (c) 2014 by David Golden.

    This is free software, licensed under:

      The Apache License, Version 2.0, January 2004