build release with static binary and release custom builder (#2)

Co-authored-by: scip <scip@noreply.codeberg.org>
Co-committed-by: scip <scip@noreply.codeberg.org>

.gitignore

@@ -0,0 +1,2 @@
+*.o
+dicepwgen

.goreleaser.yaml

@@ -0,0 +1,54 @@
+# vim: set ts=2 sw=2 tw=0 fo=cnqoj
+
+version: 2
+
+gitea_urls:
+  api: https://codeberg.org/api/v1
+  download: https://codeberg.org
+  
+builds:
+  - builder: prebuilt
+    goos:
+      - linux
+    goarch:
+      - amd64
+    goamd64:
+      - v1
+    prebuilt:
+      path: output/mybin_{{ .Os }}_{{ .Arch }}{{ with .Amd64 }}_{{ . }}{{ end }}/mybin
+    binary: bin/mybin
+
+archives:
+  - formats: [binary]
+    name_template: >-
+      {{ .ProjectName }}_
+      {{- title .Os }}_
+      {{- if eq .Arch "amd64" }}x86_64
+      {{- else if eq .Arch "386" }}i386
+      {{- else }}{{ .Arch }}{{ end }}
+      {{- if .Arm }}v{{ .Arm }}{{ end }}_{{ .Tag }}
+    wrap_in_directory: true
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"
+  groups:
+    - title: Improved
+      regexp: '^.*?(feat|add|new)(\([[:word:]]+\))??!?:.+$'
+      order: 0
+    - title: Fixed
+      regexp: '^.*?(bug|fix)(\([[:word:]]+\))??!?:.+$'
+      order: 1
+    - title: Changed
+      order: 999
+
+release:
+  header: "# Release Notes"
+  footer: >-
+
+    ---
+
+    Full Changelog: [{{ .PreviousTag }}...{{ .Tag }}](https://codeberg.org/scip/diceware/compare/{{ .PreviousTag }}...{{ .Tag }})

.woodpecker/build.yaml

@@ -0,0 +1,29 @@
+matrix:
+  platform:
+    - linux/amd64
+
+labels:
+  platform: ${platform}
+    
+steps:
+  build-n-test:
+    when:
+      event: [push]
+    image: alpine:latest
+    commands:
+      - apk update
+      - apk add --no-cache bash build-base words-en gdb valgrind
+      # build
+      - make
+      # look for memory leaks etc
+      - valgrind --leak-check=full --show-reachable=yes ./dicepwgen 2>&1 | tee log | grep "All heap blocks were freed"
+      - cat log
+      # enable in case of a crash
+      #- gdb -batch -ex "run" -ex "bt" --args dicepwgen
+      # check if we really get a password
+      - ./dicepwgen -y | grep -E '[a-z]*%'
+      # check a custom dict file and if we get 6 words when requested
+      - test 6 -eq $(./dicepwgen -f contrib/american-english-insane -c 6 | tee log | sed 's/[a-zA-Z]//g' | wc -c)
+      - cat log
+
+

.woodpecker/release.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+
+# This is my own simple codeberg generic releaser. It takes to
+# binaries to be uploaded as arguments and takes every other args from
+# env. Works on tags or normal commits (push), tags must start with v.
+
+
+set -e
+
+die() {
+    echo $*
+    exit 1
+}
+
+if test -z "$DEPLOY_TOKEN"; then
+    die "token DEPLOY_TOKEN not set"
+fi
+
+git fetch --all
+
+# determine current tag or commit hash
+version="$CI_COMMIT_TAG"
+previous=""
+log=""
+if test -z "$version"; then
+    version="${CI_COMMIT_SHA:0:6}"
+    log=$(git log -1 --oneline)
+else
+    previous=$(git tag -l | grep -E "^v" | tac | grep -A1 "$version" | tail -1)
+    log=$(git log -1 --oneline "${previous}..${version}" | sed 's|^|- |g')
+fi
+
+# release body
+printf "# Changes\n\n %s\n" "$log" > body.txt
+
+# create the release
+https --ignore-stdin --check-status -b -A bearer -a "$DEPLOY_TOKEN" POST \
+      "https://codeberg.org/api/v1/repos/${CI_REPO_OWNER}/${CI_REPO_NAME}/releases" \
+      tag_name="$version" name="Release $version" body=@body.txt > release.json
+
+# we need the id to upload files
+ID=$(jq -r .id < release.json)
+
+if test -z "$ID"; then
+    cat release.json
+    die "failed to create release"
+fi
+
+# actually upload
+for file in "$@"; do
+    https --ignore-stdin --check-status -A bearer -a "$DEPLOY_TOKEN" -f POST \
+          "https://codeberg.org/api/v1/repos/${CI_REPO_OWNER}/${CI_REPO_NAME}/releases/$ID/assets" \
+          "name=${file}-${version}" "attachment@${file}"
+done

.woodpecker/release.yaml

@@ -0,0 +1,28 @@
+# build release
+
+labels:
+  platform: linux/amd64
+    
+steps:
+  compile:
+    when:
+      event: [tag,manual]
+    image: alpine:latest
+    commands:
+      - apk update
+      - apk add --no-cache bash build-base
+      - make static
+      - file dicepwgen_static
+      - mv dicepwgen_static dicepwgen-linux-amd64
+
+  release:
+    image: alpine:latest
+    when:
+      event: [tag,manual]
+    environment:
+      DEPLOY_TOKEN:
+        from_secret: DEPLOY_TOKEN
+    commands:
+      - apk update
+      - apk add --no-cache bash httpie jq git
+      - .woodpecker/release.sh dicepwgen-linux-amd64

Makefile

@@ -22,6 +22,7 @@ CFLAGS   = -Wall -Wextra -Werror -O1 -g
 LDFLAGS  =
 OBJS     = dicepwgen.o dictfile.o tossing.o debug.o
 DST      = dicepwgen
+STATIC   = dicepwgen_static
 PREFIX   = /usr/local
 UID      = root
 GID      = 0
@@ -35,6 +36,13 @@ all: $(DST)
 $(DST): $(OBJS)
 	gcc -DDICTFILE=$(DICTFILE) $(OBJS) -o $(DST)
 
+static: $(STATIC)
+
+$(STATIC): $(OBJS)
+	gcc -DDICTFILE=$(DICTFILE) -static $(OBJS) -o $(STATIC)
+
+
+
 %.o: %.c
 	gcc -c $(CFLAGS) -DDICTFILE=$(DICTFILE) $*.c -o $*.o
 

README.md

@@ -1,6 +1,14 @@
+[![status-badge](https://ci.codeberg.org/api/badges/15537/status.svg)](https://ci.codeberg.org/repos/15537)
+[![License](https://img.shields.io/badge/license-GPL-blue.svg)](https://codeberg.org/scip/diceware/raw/branch/master/LICENSE)
+[![Documentation](https://img.shields.io/badge/manpage-documentation-blue)](https://codeberg.org/scip/diceware/raw/branch/main/dicepwgen.pod)
+
 ## dicepwgen - A diceware password generator
 
-This is the README file for the password generator dicepwgen.
+`dicepwgen` generates a [diceware password](https://de.wikipedia.org/wiki/Diceware)
+using a dictionary file. By default it uses pseudo random dice tosses,
+but it is also possible to use real dices and enter the numbers by using
+the option `-t`, which is the most secure way to generate diceware passwords.
+
 
 ## Documentation
 

dicepwgen.c

@@ -37,15 +37,13 @@ int usage() {
           "-y --symbols              Replace space with -, add non-letters\n"
           "-d --debug                Enable debug output\n"
           "-v --version              Print program version\n"
-          "-h -? --help              Print this help screen\n"
-          );
+          "-h -? --help              Print this help screen\n");
   return 1;
 }
 
 int WMIN, WMAX, humantoss, verbose, dontjump, symbols;
 
-
-int main (int argc, char **argv)  {
+int main(int argc, char **argv) {
   int count = 4;
   char *dictfile = NULL;
   int opt;
@@ -53,81 +51,82 @@ int main (int argc, char **argv)  {
   WMIN = 6;
   WMAX = 10;
   humantoss = verbose = dontjump = symbols = 0;
-  
+
   static struct option longopts[] = {
-    { "wordcount", required_argument, NULL,           'c' },
-    { "minlen",    required_argument, NULL,           'l' },
-    { "maxlen",    required_argument, NULL,           'm' },
-    { "humantoss", required_argument, NULL,           't' },    
-    { "dictfile",  required_argument, NULL,           'f' },
-    { "dontjump",  no_argument,       NULL,           'n' },
-    { "symbols",   no_argument,       NULL,           'y' },
-    { "version",   no_argument,       NULL,           'v' },
-    { "help",      no_argument,       NULL,           'h' },
-    { "debug",     no_argument,       NULL,           'd' },
+      {"wordcount", required_argument, NULL, 'c'},
+      {"minlen", required_argument, NULL, 'l'},
+      {"maxlen", required_argument, NULL, 'm'},
+      {"humantoss", required_argument, NULL, 't'},
+      {"dictfile", required_argument, NULL, 'f'},
+      {"dontjump", no_argument, NULL, 'n'},
+      {"symbols", no_argument, NULL, 'y'},
+      {"version", no_argument, NULL, 'v'},
+      {"help", no_argument, NULL, 'h'},
+      {"debug", no_argument, NULL, 'd'},
   };
 
-   while ((opt = getopt_long(argc, argv, "l:m:tf:c:vh?dny", longopts, NULL)) != -1) {
-     switch (opt) {
-     case 'v':
-       fprintf(stderr, "This is %s version %s\n", argv[0], VERSION);
-       return 1;
-       break;
-     case 'h':
-     case '?':
-       return usage();
-       break;
-     case 'c':
-       count = atoi(optarg);
-       break;
-     case 'l':
-       WMIN = atoi(optarg);
-       break;
-     case 'm':
-       WMAX = atoi(optarg);
-       break;
-     case 't':
-       humantoss = 1;
-       break;
-     case 'y':
-       symbols = 1;
-       break;
-     case 'd':
-       verbose++;
-       break;
-     case 'n':
-       dontjump = 1;
-       break;
-     case 'f':
-       dictfile = malloc(strlen(optarg));
-       strncpy(dictfile, optarg, strlen(optarg));
-       break;
-     default:
+  while ((opt = getopt_long(argc, argv, "l:m:tf:c:vh?dny", longopts, NULL)) !=
+         -1) {
+    switch (opt) {
+    case 'v':
+      fprintf(stderr, "This is %s version %s\n", argv[0], VERSION);
+      return 1;
+      break;
+    case 'h':
+    case '?':
       return usage();
       break;
-     }
-   }
+    case 'c':
+      count = atoi(optarg);
+      break;
+    case 'l':
+      WMIN = atoi(optarg);
+      break;
+    case 'm':
+      WMAX = atoi(optarg);
+      break;
+    case 't':
+      humantoss = 1;
+      break;
+    case 'y':
+      symbols = 1;
+      break;
+    case 'd':
+      verbose++;
+      break;
+    case 'n':
+      dontjump = 1;
+      break;
+    case 'f':
+      dictfile = malloc(strlen(optarg));
+      strncpy(dictfile, optarg, strlen(optarg));
+      break;
+    default:
+      return usage();
+      break;
+    }
+  }
 
-   if(dictfile == NULL) {
-     dictfile =  STRINGIZE_VALUE_OF(DICTFILE);
-   }
+  if (dictfile == NULL) {
+    dictfile = STRINGIZE_VALUE_OF(DICTFILE);
+  }
 
-   if(dontjump) {
-     WMIN = 0;
-     WMAX = 128;
-   }
-   
-   debug("     using dictfile: %s", dictfile);
-   debug("minimum word length: %d", WMIN);
-   debug("maximum word length: %d", WMAX);
-   if(humantoss)
-     debug("user rolls dices");
-   else
-     debug("program rolls dices");
-   
-   getwords(dictfile, count);
+  if (dontjump) {
+    WMIN = 0;
+    WMAX = 128;
+  }
 
-   return 0;
+  debug("     using dictfile: %s", dictfile);
+  debug("minimum word length: %d", WMIN);
+  debug("maximum word length: %d", WMAX);
+  if (humantoss)
+    debug("user rolls dices");
+  else
+    debug("program rolls dices");
+
+  getwords(dictfile, count);
+
+  return 0;
 }
 
 void getwords(char *dictfile, int count) {
@@ -140,20 +139,20 @@ void getwords(char *dictfile, int count) {
   int *tossed;
   char sep = ' ';
   unsigned char *tosses;
-  
+
   words = fetch_dict(dictfile);
 
   tossed = malloc(count * sizeof(int));
-  
-  for(i=0; i<count; i++) {
+
+  for (i = 0; i < count; i++) {
     tosses = toss(5, i);
 
-    one    = tosses[0] * 10000;
-    two    = tosses[1] *  1000;
-    three  = tosses[2] *   100;
-    four   = tosses[3] *    10;
-    five   = tosses[4];
-    
+    one = tosses[0] * 10000;
+    two = tosses[1] * 1000;
+    three = tosses[2] * 100;
+    four = tosses[3] * 10;
+    five = tosses[4];
+
     pos = one + two + three + four + five;
 
     tossed[i] = pos;
@@ -161,23 +160,23 @@ void getwords(char *dictfile, int count) {
     free(tosses);
   }
 
-  if(symbols)
+  if (symbols)
     sep = '-';
-  
-  for(i=0; i<count-1; i++) {
+
+  for (i = 0; i < count - 1; i++) {
     fprintf(stdout, "%s%c", words[tossed[i]], sep);
   }
-  fprintf(stdout, "%s", words[tossed[count-1]]);
+  fprintf(stdout, "%s", words[tossed[count - 1]]);
 
-  if(symbols)
+  if (symbols)
     fprintf(stdout, "%%8");
-  
+
   fprintf(stdout, "\n");
-  
+
   free(tossed);
 
-  for(i=0; i<6666; i++)
-    if(words[i] != NULL)
+  for (i = 0; i < 66667; i++)
+    if (words[i] != NULL)
       free(words[i]);
 
   free(words);

dicepwgen.h

@@ -20,25 +20,26 @@
  */
 
 #ifndef HAVE_DICE_H
-#define  HAVE_DICE_H
+#define HAVE_DICE_H
 
-#include <stdio.h>
-#include <unistd.h>
-#include <getopt.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <string.h>
 #include <ctype.h>
+#include <getopt.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
 
+#include "debug.h"
 #include "dictfile.h"
 #include "tossing.h"
-#include "debug.h"
 
 #define STRINGIZE(x) #x
 #define STRINGIZE_VALUE_OF(x) STRINGIZE(x)
 
-#define  VERSION  "1.2.0"
-#define  RLEN     1024
+// #define VERSION "1.3.0"
+#define RLEN 1024
+static const char VERSION[] = "1.3.0";
 
 extern int humantoss;
 extern int verbose;
@@ -48,7 +49,7 @@ extern int WMIN;
 extern int WMAX;
 
 int usage();
-int main (int argc, char **argv);
+int main(int argc, char **argv);
 void getwords(char *dictfile, int count);
 
 #endif

dictfile.c

@@ -27,39 +27,35 @@ int *incr_dicedigit(int *digits) {
     be a multiple of 10000, the 2nd a multiple of 1000 and so on.
   */
 
-  if(digits[4] == 6) {
+  if (digits[4] == 6) {
     digits[4] = 1;
-    if(digits[3] == 60) {
+    if (digits[3] == 60) {
       digits[3] = 10;
-      if(digits[2] == 600) {
-	digits[2] = 100;
-	if(digits[1] == 6000) {
-	  digits[1] = 1000;
-	  digits[0] += 10000; /* may overflow to 71111, must be catched by caller */
-	}
-	else
-	  digits[1] += 1000;
-      }
-      else
-	digits[2] += 100;
-    }
-    else
+      if (digits[2] == 600) {
+        digits[2] = 100;
+        if (digits[1] == 6000) {
+          digits[1] = 1000;
+          digits[0] +=
+              10000; /* may overflow to 71111, must be catched by caller */
+        } else
+          digits[1] += 1000;
+      } else
+        digits[2] += 100;
+    } else
       digits[3] += 10;
-  }
-  else
+  } else
     digits[4]++;
 
   return digits;
 }
 
-
 int get_dicenum(int *digits) {
   /*
     get the actual number of an array of dice digits
   */
   int i = 0;
   int pos = 0;
-  for(i=0; i<5; i++)
+  for (i = 0; i < 5; i++)
     pos += digits[i];
 
   return pos;
@@ -82,73 +78,72 @@ char **fetch_dict(char *dictfile) {
   FILE *DICT;
   int *digits;
 
-  if((DICT = fopen(dictfile, "rb")) == NULL) {
+  if ((DICT = fopen(dictfile, "rb")) == NULL) {
     perror("Could not open dictfile");
     exit(1);
   }
 
-  words = malloc(66666 * sizeof(char *));
+  words = malloc(66667 * sizeof(char *));
   digits = malloc(5 * sizeof(int));
   jump = rand_lim(32);
-  
-  digits[0] = 10000;
-  digits[1] =  1000;
-  digits[2] =   100;
-  digits[3] =    10;
-  digits[4] =     1;
 
-  pos   = 11111;
+  digits[0] = 10000;
+  digits[1] = 1000;
+  digits[2] = 100;
+  digits[3] = 10;
+  digits[4] = 1;
+
+  pos = 11111;
   next = 0;
 
-  for(i=0; i<6666; i++)
+  for (i = 0; i < 66667; i++)
     words[i] = NULL;
 
-  
- LOOP:
+LOOP:
   while ((linelen = getline(&line, &len, DICT)) != -1) {
-    if(! dontjump) {
-      if(jump > 0) {
-	jump--;
-	continue;
-      }
-      else {
-	jump = rand_lim(32);
+    if (!dontjump) {
+      if (jump > 0) {
+        jump--;
+        continue;
+      } else {
+        jump = rand_lim(32);
       }
     }
-    if(linelen >= WMIN+1 && linelen <= WMAX+1) {
-      line[linelen-1] = '\0'; /* remove newline */
+    if (linelen >= WMIN + 1 && linelen <= WMAX + 1) {
+      line[linelen - 1] = '\0'; /* remove newline */
 
-      for(i=0; i<linelen-1; i++) {
-	if(isalnum((int)line[i]) == 0) {
-	  next = 1;
-	  break;
-	}
+      for (i = 0; i < linelen - 1; i++) {
+        if (isalnum((int)line[i]) == 0) {
+          next = 1;
+          break;
+        }
       }
 
-      if(next) {
-	next = 0;
-	continue;
+      if (next) {
+        next = 0;
+        continue;
       }
 
       words[pos] = malloc(linelen);
-      strncpy( words[pos], line, linelen);
-      if(verbose > 1)
-	debug("add to wordlist at index %d: %s", pos, line);
+      strncpy(words[pos], line, linelen);
+      if (verbose > 1)
+        debug("add to wordlist at index %d: %s", pos, line);
 
       digits = incr_dicedigit(digits);
       pos = get_dicenum(digits);
 
-      /* this is what pos gets next after 66666, which is max reachable with 5 dices */
-      if(pos == 71111)
-	break;
+      /* this is what pos gets next after 66666, which is max reachable with 5
+       * dices */
+      if (pos == 71111)
+        break;
     } /* endif word 4<=>10 */
   } /* while read */
 
-  if(pos < 66666) {
+  if (pos < 66666) {
     fseek(DICT, 0L, SEEK_SET);
     goto LOOP;
   }
-  
+
   fclose(DICT);
   free(line);
   free(digits);