gssapi_mechanism_base.hpp 4.38 KB
Newer Older
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
5

6 7 8
    libzmq is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License (LGPL) as published
    by the Free Software Foundation; either version 3 of the License, or
9 10
    (at your option) any later version.

11 12 13 14 15 16 17 18 19 20 21 22 23 24
    As a special exception, the Contributors give you permission to link
    this library with independent modules to produce an executable,
    regardless of the license terms of these independent modules, and to
    copy and distribute the resulting executable under terms of your choice,
    provided that you also meet, for each linked independent module, the
    terms and conditions of the license of that module. An independent
    module is a module which is not derived from or based on this library.
    If you modify this library, you must extend this exception to your
    version of the library.

    libzmq is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
    License for more details.
25 26 27 28 29 30 31 32

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef __ZMQ_GSSAPI_MECHANISM_BASE_HPP_INCLUDED__
#define __ZMQ_GSSAPI_MECHANISM_BASE_HPP_INCLUDED__

Chris Laws's avatar
Chris Laws committed
33 34
#ifdef HAVE_LIBGSSAPI_KRB5

35
#if HAVE_GSSAPI_GSSAPI_GENERIC_H
36
#include <gssapi/gssapi_generic.h>
37
#endif
38
#include <gssapi/gssapi_krb5.h>
39 40 41

#include "mechanism.hpp"
#include "options.hpp"
42

43 44 45 46 47
namespace zmq
{

    class msg_t;

48
    /// Commonalities between clients and servers are captured here.
Mike Gatny's avatar
Mike Gatny committed
49 50 51
    /// For example, clients and servers both need to produce and
    /// process context-level GSSAPI tokens (via INITIATE commands)
    /// and per-message GSSAPI tokens (via MESSAGE commands).
52 53
    class gssapi_mechanism_base_t:
        public mechanism_t
54 55
    {
    public:
56
        gssapi_mechanism_base_t (const options_t &options_);
57 58 59
        virtual ~gssapi_mechanism_base_t () = 0;

    protected:
Mike Gatny's avatar
Mike Gatny committed
60 61
        //  Produce a context-level GSSAPI token (INITIATE command)
        //  during security context initialization.
62
        int produce_initiate (msg_t *msg_, void *data_, size_t data_len_);
Chris Laws's avatar
Chris Laws committed
63

Mike Gatny's avatar
Mike Gatny committed
64 65
        //  Process a context-level GSSAPI token (INITIATE command)
        //  during security context initialization.
66
        int process_initiate (msg_t *msg_, void **data_, size_t &data_len_);
67 68

        // Produce a metadata ready msg (READY) to conclude handshake
69
        int produce_ready (msg_t *msg_);
70 71 72

        // Process a metadata ready msg (READY)
        int process_ready (msg_t *msg_);
Chris Laws's avatar
Chris Laws committed
73

Mike Gatny's avatar
Mike Gatny committed
74 75
        //  Encode a per-message GSSAPI token (MESSAGE command) using
        //  the established security context.
76
        int encode_message (msg_t *msg_);
Chris Laws's avatar
Chris Laws committed
77

Mike Gatny's avatar
Mike Gatny committed
78 79
        //  Decode a per-message GSSAPI token (MESSAGE command) using
        //  the  established security context.
80
        int decode_message (msg_t *msg_);
Chris Laws's avatar
Chris Laws committed
81

Mike Gatny's avatar
Mike Gatny committed
82 83
        //  Acquire security context credentials from the
        //  underlying mechanism.
Chris Busbey's avatar
Chris Busbey committed
84
        static int acquire_credentials (char * principal_name_,
85
                                        gss_cred_id_t * cred_);
86 87

    protected:
Mike Gatny's avatar
Mike Gatny committed
88
        //  Opaque GSSAPI token for outgoing data
89
        gss_buffer_desc send_tok;
Chris Laws's avatar
Chris Laws committed
90

Mike Gatny's avatar
Mike Gatny committed
91
        //  Opaque GSSAPI token for incoming data
92
        gss_buffer_desc recv_tok;
Chris Laws's avatar
Chris Laws committed
93

Chris Busbey's avatar
Chris Busbey committed
94
        //  Opaque GSSAPI representation of principal
95
        gss_name_t target_name;
Chris Laws's avatar
Chris Laws committed
96

97
        //  Human-readable principal name
Chris Busbey's avatar
Chris Busbey committed
98
        char * principal_name;
99

Mike Gatny's avatar
Mike Gatny committed
100
        //  Status code returned by GSSAPI functions
101
        OM_uint32 maj_stat;
102

Mike Gatny's avatar
Mike Gatny committed
103
        //  Status code returned by the underlying mechanism
104
        OM_uint32 min_stat;
105

Mike Gatny's avatar
Mike Gatny committed
106 107
        //  Status code returned by the underlying mechanism
        //  during context initialization
108
        OM_uint32 init_sec_min_stat;
109

Mike Gatny's avatar
Mike Gatny committed
110
        //  Flags returned by GSSAPI (ignored)
111
        OM_uint32 ret_flags;
Chris Laws's avatar
Chris Laws committed
112

Mike Gatny's avatar
Mike Gatny committed
113
        //  Flags returned by GSSAPI (ignored)
114
        OM_uint32 gss_flags;
Chris Laws's avatar
Chris Laws committed
115

Mike Gatny's avatar
Mike Gatny committed
116
        //  Credentials used to establish security context
117
        gss_cred_id_t cred;
118

Mike Gatny's avatar
Mike Gatny committed
119
        //  Opaque GSSAPI representation of the security context
120
        gss_ctx_id_t context;
121 122 123

        //  If true, use gss to encrypt messages. If false, only utilize gss for auth.
        bool do_encryption;
124 125 126
    };

}
Chris Laws's avatar
Chris Laws committed
127

128
#endif
129

Chris Laws's avatar
Chris Laws committed
130
#endif