man3/memfrob.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 18:54:45 1993 by Rik Faith (faith@cs.unc.edu)
  30 .TH MEMFROB 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  31 .SH NAME
  32 memfrob \- frobnicate (encrypt) a memory area
  33 .SH SYNOPSIS
  34 .nf
  35 .BR "#define _GNU_SOURCE" "             /* See feature_test_macros(7) */"
  36 .B #include <string.h>
  37 .PP
  38 .BI "void *memfrob(void *" s ", size_t " n );
  39 .fi
  40 .SH DESCRIPTION
  41 The
  42 .BR memfrob ()
  43 function encrypts the first \fIn\fP bytes of the
  44 memory area \fIs\fP by exclusive-ORing each character with the number
  45 42.
  46 The effect can be reversed by using
  47 .BR memfrob ()
  48 on the
  49 encrypted memory area.
  50 .PP
  51 Note that this function is not a proper encryption routine as the XOR
  52 constant is fixed, and is suitable only for hiding strings.
  53 .SH RETURN VALUE
  54 The
  55 .BR memfrob ()
  56 function returns a pointer to the encrypted memory
  57 area.
  58 .SH ATTRIBUTES
  59 For an explanation of the terms used in this section, see
  60 .BR attributes (7).
  61 .ad l
  62 .nh
  63 .TS
  64 allbox;
  65 lbx lb lb
  66 l l l.
  67 Interface       Attribute       Value
  68 T{
  69 .BR memfrob ()
  70 T}      Thread safety   MT-Safe
  71 .TE
  72 .hy
  73 .ad
  74 .sp 1
  75 .SH CONFORMING TO
  76 The
  77 .BR memfrob ()
  78 function is unique to the
  79 GNU C Library.
  80 .SH SEE ALSO
  81 .BR bstring (3),
  82 .BR strfry (3)