opcua

-module(opcua).

-behaviour(application).

%% TODO %%
%%
%% - Add security checks:
%%   - The ApplicationUri specified in the Server Certificate is the same as the ApplicationUri provided in the EndpointDescription.
%%   - The Server Certificate returned in CreateSession response is the same as the Certificate used to create the SecureChannel.
%%   - The EndpointDescriptions returned from the DiscoveryEndpoint are the same as the EndpointDescriptions returned in the CreateSession response.
%%   - Client and server should check time synchronization (default: max 5 min)
%%   - Verifiy all certificates against a trusted keychain
%%   - Support sending/receiving certificate chains
%%   - Verify we are enforcing the buffer size restriction correctly (Big certificate chain?)
%%   - Stongly validate the security header


%%% INCLUDES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

-include("opcua.hrl").
-include("opcua_internal.hrl").


%%% EXPORTS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%% BEHAVIOUR application CALLBACK FUNCTIONS
-export([start/2]).
-export([stop/1]).


%%% TYPES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%-- Generic Types --------------------------------------------------------------

-type uint32() :: 0..4294967295.
-type optional(Type) :: undefined | Type.

-export_type([
    uint32/0,
    optional/1
]).

%-- OPCUA Security Types -------------------------------------------------------

-type security_policy_type() :: none | basic256sha256.

-export_type([security_policy_type/0]).


%-- OPCUA Types ----------------------------------------------------------------

-type endpoint_url() :: #opcua_endpoint_url{}.
-type node_id_type() :: numeric | string | guid | opaque.
-type node_id() :: #opcua_node_id{}.
-type node_origin() :: nodeset | local | remote.
-type expanded_node_id() :: #opcua_expanded_node_id{}.
-type qualified_name() :: #opcua_qualified_name{}.
-type localized_text() :: #opcua_localized_text{}.
-type extension_object() :: #opcua_extension_object{}.
-type variant() :: #opcua_variant{}.
-type data_value() :: #opcua_data_value{}.
-type diagnostic_info() :: #opcua_diagnostic_info{}.
-type node_spec() :: non_neg_integer() | atom() | binary() | node_id() | node_rec().
-type codec_spec() :: node_spec() | [node_spec()] | [{atom(), node_spec()}].
-type stream_encoding() :: binary | xml | json.
-type extobj_encoding() :: xml | byte_string.
-type codec_schema() :: term().
-type field() :: #opcua_field{}.
-type fields() :: [field()].
-type value_rank() :: -1 | pos_integer().
-type builtin_type() :: boolean | byte | sbyte | uint16 | uint32 | uint64
                      | int16 | int32 | int64 | float | double | string
                      | date_time | guid | xml | status_code | byte_string
                      | node_id | expanded_node_id | diagnostic_info
                      | qualified_name | localized_text | extension_object
                      | variant | data_value.
-type data_type() :: builtin_type() | node_id().
-type array_dimensions() :: [] | [non_neg_integer()].

-export_type([
    endpoint_url/0,
    node_id_type/0,
    node_id/0,
    expanded_node_id/0,
    qualified_name/0,
    localized_text/0,
    extension_object/0,
    variant/0,
    data_value/0,
    diagnostic_info/0,
    node_spec/0,
    codec_spec/0,
    stream_encoding/0,
    extobj_encoding/0,
    codec_schema/0,
    field/0,
    fields/0,
    value_rank/0,
    builtin_type/0,
    data_type/0,
    array_dimensions/0
]).


%-- Node Model Types -----------------------------------------------------------

-type reference_type() ::   references |
                            hierarchical_references |
                            non_hierarchical_references |
                            has_event_source |
                            has_child |
                            organizes |
                            has_notifier |
                            aggregates |
                            has_subtype |
                            has_property |
                            has_component |
                            has_ordered_component |
                            generates_event |
                            always_generates_event |
                            has_encoding |
                            has_modelling_rule |
                            has_type_definition.

-type permission() ::       browse |
                            read_role_permissions |
                            write_attribute |
                            write_role_permissions |
                            write_historizing |
                            read |
                            write |
                            read_history |
                            insert_history |
                            modify_history |
                            delete_history |
                            receive_events |
                            call |
                            add_reference |
                            remove_reference |
                            delete_node |
                            add_node.

-type node_class() ::       object |
                            variable |
                            method |
                            object_type |
                            variable_type |
                            reference_type |
                            data_type |
                            view.

-type node_class_rec() ::   #opcua_object{} |
                            #opcua_variable{} |
                            #opcua_method{} |
                            #opcua_object_type{} |
                            #opcua_variable_type{} |
                            #opcua_reference_type{} |
                            #opcua_data_type{} |
                            #opcua_view{}.

-type permissions() :: [permission()].
-type role_permission() :: #opcua_role_permission{}.
-type role_permissions() :: [role_permission()].
-type access_level() :: current_read |
                        current_write |
                        history_read |
                        history_write |
                        semantic_change |
                        status_write |
                        timestamp_write |
                        nonatomic_read |
                        nonatomic_write |
                        write_full_array_only.
-type node_rec() :: #opcua_node{}.
-type node_ref() :: #opcua_reference{}.
-type node_refs() :: [node_ref()].
-type status() :: atom() | pos_integer().
-type error() :: #opcua_error{}.
-type references_options() :: #{
    include_subtypes => boolean(),
    type => undefined | opcua:node_spec(),
    direction => opcua:direction()
}.

-export_type([
    reference_type/0,
    permission/0,
    node_class/0,
    node_class_rec/0,
    permissions/0,
    role_permission/0,
    role_permissions/0,
    access_level/0,
    node_rec/0,
    node_ref/0,
    node_refs/0,
    status/0,
    error/0,
    references_options/0
]).


%-- Node Commands Types --------------------------------------------------------

-type timestamp_type() :: source | server | both | neither | invalid.
-type max_age() :: cached | newest | pos_integer().
-type direction() :: forward | inverse | both.
-type range() :: Index :: non_neg_integer()
               | {Min :: non_neg_integer(), Max :: non_neg_integer()}.
-type reference_description() :: #{
    node_id := opcua:node_id(),
    reference_type_id => opcua:node_id(),
    is_forward => boolean(),
    browse_name => #opcua_qualified_name{},
    display_name => #opcua_localized_text{},
    node_class => atom(),
    type_definition => #opcua_expanded_node_id{}
}.

-type read_options() :: #{
    max_age => max_age(),
    timestamp_type => timestamp_type()
}.
-type read_result() :: #opcua_data_value{}.

-type browse_options() :: #{
    max_refs => non_neg_integer()
}.
-type browse_result() :: #{
    status => atom(),
    references => [reference_description()]
}.

-export_type([
    timestamp_type/0,
    max_age/0,
    direction/0,
    range/0,
    reference_description/0,
    read_options/0,
    read_result/0,
    browse_options/0,
    browse_result/0
]).


%-- Protocol Types -------------------------------------------------------------

-type message_type() :: hello | acknowledge | reverse_hello | error
                      | channel_open | channel_close | channel_message.
-type message_sender() :: client | server.
-type chunk_type() :: final | intermediate | aborted.
-type chunk_state() :: undefined | locked | unlocked.
-type token_id() :: pos_integer().
-type channel_id() :: pos_integer().
-type sequence_num() :: pos_integer().
-type request_id() :: pos_integer().
-type symmetric_keys() :: #uacp_symmetric_keys{}.
-type security_policy() :: #uacp_security_policy{}.
-type security_mode() :: none | sign | sign_and_encrypt.
-type auth_token_type() :: anonymous | user_name.
-type security_data() :: #uacp_chunk_security{}.
-type chunk() :: #uacp_chunk{}.
-type message() :: #uacp_message{}.
-type connection() :: #uacp_connection{}.

-type hello_payload() :: #{
    ver := non_neg_integer(),
    max_res_chunk_size := non_neg_integer(),
    max_req_chunk_size := non_neg_integer(),
    max_msg_size := non_neg_integer(),
    max_chunk_count := non_neg_integer(),
    endpoint_url := undefined | binary()
}.

-type acknowledge_payload() :: #{
    ver := non_neg_integer(),
    max_res_chunk_size := non_neg_integer(),
    max_req_chunk_size := non_neg_integer(),
    max_msg_size := non_neg_integer(),
    max_chunk_count := non_neg_integer()
}.

-type error_payload() :: #{
    error := non_neg_integer(),
    reason := undefined | binary()
}.

-export_type([
    message_type/0,
    chunk_type/0,
    chunk_state/0,
    token_id/0,
    channel_id/0,
    sequence_num/0,
    request_id/0,
    symmetric_keys/0,
    security_policy/0,
    security_mode/0,
    auth_token_type/0,
    security_data/0,
    chunk/0,
    message/0,
    connection/0,
    hello_payload/0,
    acknowledge_payload/0,
    error_payload/0
]).


%%% BEHAVIOUR application CALLBACK FUNCTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

start(_StartType, _StartArgs) ->
    case opcua_sup:start_link() of
        {error, _Reason} = Error -> Error;
        {ok, Pid} ->
            case application:get_env(start_server) of
                {ok, false} ->
                    ok;
                _ ->
                    {ok, _} = opcua_server_ranch_protocol:start_listener()
            end,
            {ok, Pid}
    end.

stop(_State) ->
    opcua_server_ranch_protocol:stop_listener().


%%% INTERNAL FUNCTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%