srsq.h

Go to the documentation of this file.

#ifndef SRSQ_H
#define SRSQ_H
#include <stdint.h>
#include <time.h>
#include "str.h"
#include "case.h"
#include "stralloc.h"
 
/* Original copyright (c) 2004 Shevek (srs@anarres.org)
 * adapted for fehQlibs, 2025 feh
 */
 
#define SRSDEL '='
#define SRSSEP "="
#define SRS0TAG "SRS0"
#define SRS1TAG "SRS1"
#define SRS_HASHLEN 3
 
/* Error codes */
 
#define SRS_ERRTYPE_MASK   0xf000
#define SRS_ERRTYPE_NONE   0x0000
#define SRS_ERRTYPE_CONFIG 0x1000
#define SRS_ERRTYPE_OPER   0x2000
#define SRS_ERRTYPE_SYNTAX 0x4000
#define SRS_ERRTYPE_SRS    0x8000
 
#define SRS_SUCCESS         (0)
#define SRS_ENOTSRSADDRESS  (1)
#define SRS_ENOTREWRITTEN   (2)
#define SRS_ENOSENDERATSIGN (3)
 
#define SRS_ENOSECRETS        (SRS_ERRTYPE_CONFIG | 1)
#define SRS_ESEPARATORINVALID (SRS_ERRTYPE_CONFIG | 2)
 
#define SRS_EOUTOFMEMORY      (SRS_ERRTYPE_OPER   | 1)
 
#define SRS_ENOSRS0HOST       (SRS_ERRTYPE_SYNTAX | 1)
#define SRS_ENOSRS0USER       (SRS_ERRTYPE_SYNTAX | 2)
#define SRS_ENOSRS0HASH       (SRS_ERRTYPE_SYNTAX | 3)
#define SRS_ENOSRS0STAMP      (SRS_ERRTYPE_SYNTAX | 4)
#define SRS_ENOSRS1HOST       (SRS_ERRTYPE_SYNTAX | 5)
#define SRS_ENOSRS1USER       (SRS_ERRTYPE_SYNTAX | 6)
#define SRS_ENOSRS1HASH       (SRS_ERRTYPE_SYNTAX | 7)
#define SRS_EBADTIMESTAMPCHAR (SRS_ERRTYPE_SYNTAX | 8)
#define SRS_EHASHTOOSHORT     (SRS_ERRTYPE_SYNTAX | 9)
 
#define SRS_ETIMESTAMPOUTOFDATE (SRS_ERRTYPE_SRS  | 1)
#define SRS_EHASHINVALID      (SRS_ERRTYPE_SRS    | 2)
 
#define SRS_ERROR_TYPE(x) ((x) & SRS_ERRTYPE_MASK)
 
/* SRS implementation */
 
#define SRS_IS_SRS_ADDRESS(x) ( \
  (case_diffb((x),3,"SRS") == 0) && \
  (str_chr("01", (x)[3]) != 2) && \
  (str_chr("-+=", (x)[4]) != 4) \
)
 
#define X(e,s) if (code == e) return s;
 
/* The main building block */
 
typedef struct {
  /* Rewriting parameters */
  stralloc secrets;
  int numsecrets;
  char separator;
 
  /* Security parameters */
  int maxage;                /* Maximum allowed age in seconds */
  int hashlen;
  int hashmin;
 
  /* Behaviour parameters */
  int alwaysrewrite;         /* Rewrite even into same domain? */
  int noforward;             /* Never perform forwards rewriting */
  int noreverse;             /* Never perform reverse rewriting */
  stralloc nonrewrite;       /* A list of non-rewritten domains */
} srs_ctx;
 
/* Interface */
int srs_init(srs_ctx *);
int srs_forward(srs_ctx *,stralloc *,const char *,const char *);
int srs_reverse(srs_ctx *,stralloc *,char *);
const char *srs_errorstr(int);
 /* You probably shouldn't call these. */
int srs_create_timestamp(char *,time_t);
int srs_check_timestamp(srs_ctx *,char *);
 
#endif  /* SRSQ_H */