FreeRDP/include/freerdp/crypto/ber.h

/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * ASN.1 Basic Encoding Rules (BER)
 *
 * Copyright 2011-2012 Marc-Andre Moreau <marcandre.moreau@gmail.com>
 *
 * 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 FREERDP_CRYPTO_BER_H
#define FREERDP_CRYPTO_BER_H

#include <freerdp/api.h>
#include <freerdp/types.h>

#include <winpr/stream.h>

/* BER type */

/* Class - bits 8 and 7 */
#define BER_CLASS_MASK 0xC0
#define BER_CLASS_UNIV 0x00 /* 0 0 */
#define BER_CLASS_APPL 0x40 /* 0 1 */
#define BER_CLASS_CTXT 0x80 /* 1 0 */
#define BER_CLASS_PRIV 0xC0 /* 1 1 */

/* P/C - bit 6 */
#define BER_PC_MASK 0x20
#define BER_PRIMITIVE 0x00 /* 0 */
#define BER_CONSTRUCT 0x20 /* 1 */

/* Tag - bits 5 to 1 */
#define BER_TAG_MASK 0x1F
#define BER_TAG_BOOLEAN 0x01
#define BER_TAG_INTEGER 0x02
#define BER_TAG_BIT_STRING 0x03
#define BER_TAG_OCTET_STRING 0x04
#define BER_TAG_OBJECT_IDENFIER 0x06
#define BER_TAG_ENUMERATED 0x0A
#define BER_TAG_SEQUENCE 0x10
#define BER_TAG_SEQUENCE_OF 0x10

#define BER_PC(_pc) (_pc ? BER_CONSTRUCT : BER_PRIMITIVE)

#ifdef __cplusplus
extern "C"
{
#endif

	FREERDP_API BOOL ber_read_length(wStream* s, size_t* length);
	FREERDP_API size_t ber_write_length(wStream* s, size_t length);
	FREERDP_API size_t _ber_sizeof_length(size_t length);
	FREERDP_API BOOL ber_read_universal_tag(wStream* s, BYTE tag, BOOL pc);
	FREERDP_API size_t ber_write_universal_tag(wStream* s, BYTE tag, BOOL pc);
	FREERDP_API BOOL ber_read_application_tag(wStream* s, BYTE tag, size_t* length);
	FREERDP_API void ber_write_application_tag(wStream* s, BYTE tag, size_t length);
	FREERDP_API BOOL ber_read_enumerated(wStream* s, BYTE* enumerated, BYTE count);
	FREERDP_API void ber_write_enumerated(wStream* s, BYTE enumerated, BYTE count);
	FREERDP_API BOOL ber_read_contextual_tag(wStream* s, BYTE tag, size_t* length, BOOL pc);
	FREERDP_API size_t ber_write_contextual_tag(wStream* s, BYTE tag, size_t length, BOOL pc);
	FREERDP_API size_t ber_sizeof_contextual_tag(size_t length);
	FREERDP_API BOOL ber_read_sequence_tag(wStream* s, size_t* length);
	FREERDP_API size_t ber_write_sequence_tag(wStream* s, size_t length);
	FREERDP_API size_t ber_sizeof_sequence(size_t length);
	FREERDP_API size_t ber_sizeof_sequence_tag(size_t length);
	FREERDP_API BOOL ber_read_bit_string(wStream* s, size_t* length, BYTE* padding);

	FREERDP_API BOOL ber_read_octet_string_tag(wStream* s, size_t* length);
	FREERDP_API BOOL ber_read_octet_string(wStream* s, BYTE** content, size_t* length);
	FREERDP_API size_t ber_write_octet_string_tag(wStream* s, size_t length);
	FREERDP_API size_t ber_sizeof_octet_string(size_t length);
	FREERDP_API size_t ber_sizeof_contextual_octet_string(size_t length);
	FREERDP_API size_t ber_write_char_to_unicode_octet_string(wStream* s, const char* str);
	FREERDP_API size_t ber_write_contextual_char_to_unicode_octet_string(wStream* s, BYTE tag,
	                                                                     const char* oct_str);
	FREERDP_API size_t ber_write_octet_string(wStream* s, const BYTE* oct_str, size_t length);
	FREERDP_API BOOL ber_read_char_from_unicode_octet_string(wStream* s, char** str);
	FREERDP_API BOOL ber_read_unicode_octet_string(wStream* s, LPWSTR* str);
	FREERDP_API size_t ber_write_contextual_octet_string(wStream* s, BYTE tag, const BYTE* oct_str,
	                                                     size_t length);
	FREERDP_API size_t ber_write_contextual_unicode_octet_string(wStream* s, BYTE tag, LPWSTR str);

	FREERDP_API BOOL ber_read_BOOL(wStream* s, BOOL* value);
	FREERDP_API void ber_write_BOOL(wStream* s, BOOL value);
	FREERDP_API BOOL ber_read_integer(wStream* s, UINT32* value);
	FREERDP_API size_t ber_write_integer(wStream* s, UINT32 value);
	FREERDP_API size_t ber_write_contextual_integer(wStream* s, BYTE tag, UINT32 value);
	FREERDP_API BOOL ber_read_integer_length(wStream* s, size_t* length);
	FREERDP_API size_t ber_sizeof_integer(UINT32 value);
	FREERDP_API size_t ber_sizeof_contextual_integer(UINT32 value);

#ifdef __cplusplus
}
#endif

#endif /* FREERDP_CRYPTO_BER_H */