m2msecurity.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 ARM Limited. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 * 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.
 */
#ifndef M2M_SECURITY_H
#define M2M_SECURITY_H

#include "mbed-client/m2mobject.h"

// FORWARD DECLARATION
class M2MResource;


class  M2MSecurity : public M2MObject {

friend class M2MInterfaceFactory;
friend class M2MNsdlInterface;

public:

    typedef enum {
        M2MServerUri,
        BootstrapServer,
        SecurityMode,
        PublicKey,
        ServerPublicKey,
        Secretkey,
        SMSSecurityMode,
        SMSBindingKey,
        SMSBindingSecretKey,
        M2MServerSMSNumber,
        ShortServerID,
        ClientHoldOffTime,
        OpenCertificateChain,
        CloseCertificateChain,
        ReadDeviceCertificateChain
    } SecurityResource;

    typedef enum {
        SecurityNotSet = -1,
        Psk = 0,
        Certificate = 2,
        NoSecurity = 3,
        EST = 4
    } SecurityModeType;

    typedef enum {
        M2MServer = 0x0,
        Bootstrap = 0x1,
        NotDefined =0x2
    } ServerType;

private:

    M2MSecurity(ServerType server_type);


    virtual ~M2MSecurity();

    // Prevents the use of default constructor.
    M2MSecurity();

    // Prevents the use of assignment operator.
    M2MSecurity& operator=( const M2MSecurity& /*other*/ );

    // Prevents the use of copy constructor
    M2MSecurity( const M2MSecurity& /*other*/ );

public:

    static M2MSecurity* get_instance();

    static void delete_instance();

    M2MObjectInstance* create_object_instance(ServerType server_type);

    M2MObjectInstance* create_object_instance(uint16_t instance_id);

    void remove_security_instances();

    M2MResource* create_resource(SecurityResource rescource, uint32_t value, uint16_t instance_id);

    bool delete_resource(SecurityResource rescource, uint16_t instance_id);

    bool set_resource_value(SecurityResource resource,
                            const String &value,
                            uint16_t instance_id);

    bool set_resource_value(SecurityResource resource,
                            uint32_t value,
                            uint16_t instance_id);

    bool set_resource_value(SecurityResource resource,
                            const uint8_t *value,
                            const uint16_t length,
                            uint16_t instance_id);

    String resource_value_string(SecurityResource resource, uint16_t instance_id) const;

    int resource_value_buffer(SecurityResource resource,
                              uint8_t *&data,
                              uint16_t instance_id,
                              size_t *buffer_len) const;

    uint32_t resource_value_buffer(SecurityResource resource,
                                   const uint8_t *&data,
                                   uint16_t instance_id) const;

    int resource_value_buffer_size(SecurityResource resource,
                                   uint16_t instance_id,
                                   size_t *buffer_len) const;

    uint32_t resource_value_int(SecurityResource resource,
                                uint16_t instance_id) const;

    bool is_resource_present(SecurityResource resource,
                             uint16_t instance_id) const;

    uint16_t total_resource_count(uint16_t instance_id) const;

    ServerType server_type(uint16_t instance_id) const;

    int32_t get_security_instance_id(ServerType server_type) const;

    M2MResource* get_resource(SecurityResource resource, uint16_t instance_id = 0) const;
private:


    void clear_resources();
    void clear_resources(uint16_t instance_id);
    void create_resources(M2MObjectInstance *server_instance,
                          M2MSecurity::ServerType server_type);

protected:
    static M2MSecurity*          _instance;

    friend class Test_M2MSecurity;
    friend class Test_M2MInterfaceImpl;
    friend class Test_M2MConnectionSecurityImpl;
    friend class Test_M2MConnectionHandlerPimpl_linux;
    friend class Test_M2MConnectionHandlerPimpl_mbed;
    friend class Test_M2MConnectionSecurityPimpl;
    friend class Test_M2MNsdlInterface;
    friend class Test_M2MConnectionHandlerPimpl_classic;
};

#endif // M2M_SECURITY_H