capa.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-2020 Seagate Technology LLC and/or its Affiliates
 *
 * 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.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_CAPA_CAPA_H__
#define __MOTR_CAPA_CAPA_H__

#include "lib/atomic.h"
#include "net/net.h"

enum m0_capa_entity_type {
        M0_CAPA_ENTITY_OBJECT,
        M0_CAPA_ENTITY_LOCKS,
        M0_CAPA_ENTITY_LAYOUT,
};

enum m0_capa_operation {
        M0_CAPA_OP_DATA_READ,
        M0_CAPA_OP_DATA_WRITE,
};

enum {
        M0_CAPA_HMAC_MAX_LEN = 64
};

struct m0_capa_issuer {

};

struct m0_capa_ctxt;
struct m0_object_capa {
        struct m0_capa_ctxt     *oc_ctxt;
        struct m0_capa_issuer   *oc_owner;
        enum m0_capa_entity_type oc_type;
        enum m0_capa_operation   oc_opcode;
        struct m0_atomic64       oc_ref;

        void                    *oc_data;
        char                     oc_opaque[M0_CAPA_HMAC_MAX_LEN];
};

struct m0_capa_ctxt {
};

M0_INTERNAL int m0_capa_ctxt_init(struct m0_capa_ctxt *ctxt);

M0_INTERNAL void m0_capa_ctxt_fini(struct m0_capa_ctxt *ctxt);

M0_INTERNAL int m0_capa_new(struct m0_object_capa *capa,
                            enum m0_capa_entity_type type,
                            enum m0_capa_operation opcode, void *data);

M0_INTERNAL int m0_capa_get(struct m0_capa_ctxt *ctxt,
                            struct m0_capa_issuer *owner,
                            struct m0_object_capa *capa);

/*
   Put Capability for an object

   @param ctxt [in]the execution context.
   @param capa [in]capa to be released.

   Reference count will be decreased. When reference count drops to zero,
   it will be finalized and can not be used any more.
*/
M0_INTERNAL void m0_capa_put(struct m0_capa_ctxt *ctxt,
                             struct m0_object_capa *capa);


M0_INTERNAL int m0_capa_auth(struct m0_capa_ctxt *ctxt,
                             struct m0_object_capa *capa,
                             enum m0_capa_operation op);


/* __MOTR_CAPA_CAPA_H__ */
#endif

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */