libzmq/src/gssapi_mechanism_base.hpp

113 lines
3.6 KiB
C++
Raw Normal View History

/*
Copyright (c) 2007-2013 Contributors as noted in the AUTHORS file
This file is part of 0MQ.
0MQ is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
0MQ 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.
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__
#include <gssapi/gssapi_generic.h>
#include <gssapi/gssapi_krb5.h>
#include "mechanism.hpp"
#include "options.hpp"
namespace zmq
{
class msg_t;
/// Commonalities between clients and servers are captured here.
2013-10-08 07:25:18 +02:00
/// 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).
class gssapi_mechanism_base_t:
public mechanism_t
{
public:
gssapi_mechanism_base_t (const options_t &options_);
virtual ~gssapi_mechanism_base_t () = 0;
protected:
2013-10-08 07:25:18 +02:00
// Produce a context-level GSSAPI token (INITIATE command)
// during security context initialization.
int produce_initiate (msg_t *msg_, void *data_, size_t data_len_);
2013-10-08 07:25:18 +02:00
// Process a context-level GSSAPI token (INITIATE command)
// during security context initialization.
int process_initiate (msg_t *msg_, void **data_, size_t &data_len_);
// Produce a metadata ready msg (READY) to conclude handshake
int produce_ready (msg_t *msg_) const;
// Process a metadata ready msg (READY)
int process_ready (msg_t *msg_);
2013-10-08 07:25:18 +02:00
// Encode a per-message GSSAPI token (MESSAGE command) using
// the established security context.
int encode_message (msg_t *msg_);
2013-10-08 07:25:18 +02:00
// Decode a per-message GSSAPI token (MESSAGE command) using
// the established security context.
int decode_message (msg_t *msg_);
2013-10-08 07:25:18 +02:00
// Acquire security context credentials from the
// underlying mechanism.
2014-04-23 19:20:22 +02:00
static int acquire_credentials (char * principal_name_,
gss_cred_id_t * cred_);
protected:
2013-10-08 07:25:18 +02:00
// Opaque GSSAPI token for outgoing data
gss_buffer_desc send_tok;
2013-10-08 07:25:18 +02:00
// Opaque GSSAPI token for incoming data
gss_buffer_desc recv_tok;
2014-04-23 19:20:22 +02:00
// Opaque GSSAPI representation of principal
gss_name_t target_name;
// Human-readable principal name
2014-04-23 19:20:22 +02:00
char * principal_name;
2013-10-08 07:25:18 +02:00
// Status code returned by GSSAPI functions
OM_uint32 maj_stat;
2013-10-08 07:25:18 +02:00
// Status code returned by the underlying mechanism
OM_uint32 min_stat;
2013-10-08 07:25:18 +02:00
// Status code returned by the underlying mechanism
// during context initialization
OM_uint32 init_sec_min_stat;
2013-10-08 07:25:18 +02:00
// Flags returned by GSSAPI (ignored)
OM_uint32 ret_flags;
2013-10-08 07:25:18 +02:00
// Flags returned by GSSAPI (ignored)
OM_uint32 gss_flags;
2013-10-08 07:25:18 +02:00
// Credentials used to establish security context
gss_cred_id_t cred;
2013-10-08 07:25:18 +02:00
// Opaque GSSAPI representation of the security context
gss_ctx_id_t context;
};
}
#endif