/* Copyright (c) 2001-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
 * Copyright (c) 2007-2021, The Tor Project, Inc. */
/* See LICENSE for licensing information */

/**
 * \file dirlist.h
 * \brief Header file for dirlist.c
 **/

#ifndef TOR_DIRLIST_H
#define TOR_DIRLIST_H

typedef struct auth_dirport_t auth_dirport_t;
/**
 * Different usages for an authority's HTTP directory port.
 *
 * Historically, only legacy ports existed; proposal 330 added multiple types
 * of dirport to better enable authorities to offload work and resist DoS
 * attacks.
 **/
typedef enum auth_dirport_usage_t {
  /** Flag for an authority's dirport that is intended for misc/legacy
   * usage. May be used when no other dirport is available. */
  AUTH_USAGE_LEGACY,
  /** Flag for an authority's dirport that is intended for descriptor uploads
   * only. */
  AUTH_USAGE_UPLOAD,
  /** Flag for an authority's dirport that is intended for voting only */
  AUTH_USAGE_VOTING,
  /** Flag for an authority's dirport that is intended for relay downloads
   * only. */
  AUTH_USAGE_DOWNLOAD,
} auth_dirport_usage_t;

int get_n_authorities(dirinfo_type_t type);
const smartlist_t *router_get_trusted_dir_servers(void);
const smartlist_t *router_get_fallback_dir_servers(void);
smartlist_t *router_get_trusted_dir_servers_mutable(void);
smartlist_t *router_get_fallback_dir_servers_mutable(void);
void mark_all_dirservers_up(smartlist_t *server_list);

auth_dirport_usage_t auth_dirport_usage_for_purpose(int purpose);

dir_server_t *router_get_trusteddirserver_by_digest(const char *d);
dir_server_t *router_get_fallback_dirserver_by_digest(
                                                   const char *digest);
int router_digest_is_fallback_dir(const char *digest);
MOCK_DECL(dir_server_t *, trusteddirserver_get_by_v3_auth_digest,
          (const char *d));

MOCK_DECL(int, router_digest_is_trusted_dir_type,
        (const char *digest, dirinfo_type_t type));

const tor_addr_port_t *trusted_dir_server_get_dirport(const dir_server_t *ds,
                                                  auth_dirport_usage_t usage,
                                                  int addr_family);
const tor_addr_port_t *trusted_dir_server_get_dirport_exact(
                                                  const dir_server_t *ds,
                                                  auth_dirport_usage_t usage,
                                                  int addr_family);

bool router_addr_is_trusted_dir_type(const tor_addr_t *addr,
                                     dirinfo_type_t type);
#define router_addr_is_trusted_dir(d) \
  router_addr_is_trusted_dir_type((d), NO_DIRINFO)

#define router_digest_is_trusted_dir(d) \
  router_digest_is_trusted_dir_type((d), NO_DIRINFO)

dir_server_t *trusted_dir_server_new(const char *nickname, const char *address,
                       uint16_t dir_port, uint16_t or_port,
                       const tor_addr_port_t *addrport_ipv6,
                       const char *digest, const char *v3_auth_digest,
                       dirinfo_type_t type, double weight);
void trusted_dir_server_add_dirport(dir_server_t *ds,
                                    auth_dirport_usage_t usage,
                                    const tor_addr_port_t *dirport);
dir_server_t *fallback_dir_server_new(const tor_addr_t *addr,
                                      uint16_t dir_port, uint16_t or_port,
                                      const tor_addr_port_t *addrport_ipv6,
                                      const char *id_digest, double weight);
void dir_server_add(dir_server_t *ent);

void clear_dir_servers(void);
void dirlist_free_all(void);

MOCK_DECL(void, dirlist_add_trusted_dir_addresses, (void));

#endif /* !defined(TOR_DIRLIST_H) */