import ceph 15.2.11

[ceph.git] / ceph / src / auth / AuthServiceHandler.h

// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*- 
// vim: ts=8 sw=2 smarttab
/*
 * Ceph - scalable distributed file system
 *
 * Copyright (C) 2004-2009 Sage Weil <sage@newdream.net>
 *
 * This is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License version 2.1, as published by the Free Software 
 * Foundation.  See file COPYING.
 * 
 */

#ifndef CEPH_AUTHSERVICEHANDLER_H
#define CEPH_AUTHSERVICEHANDLER_H

#include <stddef.h>              // for NULL
#include <stdint.h>              // for uint64_t
#include "common/entity_name.h"  // for EntityName
#include "include/common_fwd.h"
#include "include/buffer_fwd.h"  // for ceph::buffer::list

class KeyServer;
class CryptoKey;
struct AuthCapsInfo;

enum class global_id_status_t {
  NONE,
  // fresh client (global_id == 0); waiting for CephXAuthenticate
  NEW_PENDING,
  // connected client; new enough to correctly reclaim global_id
  NEW_OK,
  // connected client; unknown whether it can reclaim global_id correctly
  NEW_NOT_EXPOSED,
  // reconnecting client (global_id != 0); waiting for CephXAuthenticate
  RECLAIM_PENDING,
  // reconnected client; correctly reclaimed global_id
  RECLAIM_OK,
  // reconnected client; did not properly prove prior global_id ownership
  RECLAIM_INSECURE
};

std::ostream& operator<<(std::ostream& os,
			 global_id_status_t global_id_status);

struct AuthServiceHandler {
protected:
  CephContext *cct;
  EntityName entity_name;
  uint64_t global_id = 0;
  global_id_status_t global_id_status = global_id_status_t::NONE;

public:
  explicit AuthServiceHandler(CephContext *cct_) : cct(cct_) {}

  virtual ~AuthServiceHandler() { }

  int start_session(const EntityName& entity_name,
		    uint64_t global_id,
		    bool is_new_global_id,
		    ceph::buffer::list *result,
		    AuthCapsInfo *caps);
  virtual int handle_request(ceph::buffer::list::const_iterator& indata,
			     size_t connection_secret_required_length,
			     ceph::buffer::list *result,
			     AuthCapsInfo *caps,
			     CryptoKey *session_key,
			     std::string *connection_secret) = 0;

  const EntityName& get_entity_name() { return entity_name; }
  uint64_t get_global_id() { return global_id; }
  global_id_status_t get_global_id_status() { return global_id_status; }

private:
  virtual int do_start_session(bool is_new_global_id,
			       ceph::buffer::list *result,
			       AuthCapsInfo *caps) = 0;
};

extern AuthServiceHandler *get_auth_service_handler(int type, CephContext *cct, KeyServer *ks);

#endif