NET_Utils.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        NET_Utils.h
 *
 * COMMENTS:
 *
 */

#ifndef __NET_UTILS_H__
#define __NET_UTILS_H__

#include "NET_API.h"

#include <UT/UT_JSONWriter.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_UniquePtr.h>

class UT_NetSocket;
class UT_WorkBuffer;
class UT_IpAddressV4;

enum class NET_DigestAlgorithmTypes;

/// Determine the default CA Path used by Houdini
NET_API UT_StringHolder NETdetermineCAPath();

/// Determine the default CA Info path used by Houdini
NET_API UT_StringHolder NETdetermineCAInfo();

NET_API void NETgetLocalAndRemoteIPs(
        UT_NetSocket *sock,
        UT_IpAddressV4& local_ip,
        UT_IpAddressV4& remote_ip);

NET_API bool NETmatchIPMask(
        const UT_IpAddressV4& server_ip,
        const UT_IpAddressV4& client_ip,
        const char *ipmask);

NET_API UT_UniquePtr<UT_JSONWriter> NETcreateJSONWriter(UT_WorkBuffer &content);

NET_API UT_StringHolder NEThttpDate();

NET_API UT_StringHolder NETgenerateRandomString(int length);

/// Remove any dot segments present in the provided url path.
NET_API UT_StringHolder NETremoveDotSegmentsInUrlPath(const UT_StringRef& p);

/// HTML escape text to ensure security saftey.
NET_API UT_StringHolder NEThtmlEscape(const UT_StringHolder& name);

/// Split a stored password into its components so that it can be checked
/// against with raw passwords.
NET_API bool NETsplitPassword(
        const UT_StringHolder& password,
        UT_StringHolder& alg_string,
        int& iterations,
        UT_StringHolder& salt,
        UT_StringHolder& hashed_password);

NET_API void NETparseUserAgent(
        const UT_StringView& user_agent,
        UT_StringHolder* version = nullptr,
        UT_StringHolder* platform = nullptr);

#endif // __NET_UTILS_H__