Caesar
For this problem, you’ll implement a program that encrypts messages using Caesar’s cipher, per the below.
$ ./caesar 13
plaintext: HELLO
ciphertext: URYYB
Getting Started
Open VS Code.
Start by clicking inside your terminal window, then execute cd
by itself. You should find that its “prompt” resembles the below.
$
Click inside of that terminal window and then execute
wget https://cdn.cs50.net/2021/fall/psets/2/caesar.zip
followed by Enter in order to download a ZIP called caesar.zip
in your codespace. Take care not to overlook the space between wget
and the following URL, or any other character for that matter!
Now execute
unzip caesar.zip
to create a folder called caesar
. You no longer need the ZIP file, so you can execute
rm caesar.zip
and respond with “y” followed by Enter at the prompt to remove the ZIP file you downloaded.
Now type
cd caesar
followed by Enter to move yourself into (i.e., open) that directory. Your prompt should now resemble the below.
caesar/ $
If all was successful, you should execute
ls
and see a file named caesar.c
. Executing code caesar.c
should open the file where you will type your code for this problem set. If not, retrace your steps and see if you can determine where you went wrong!
Background
Supposedly, Caesar (yes, that Caesar) used to “encrypt” (i.e., conceal in a reversible way) confidential messages by shifting each letter therein by some number of places. For instance, he might write A as B, B as C, C as D, …, and, wrapping around alphabetically, Z as A. And so, to say HELLO to someone, Caesar might write IFMMP instead. Upon receiving such messages from Caesar, recipients would have to “decrypt” them by shifting letters in the opposite direction by the same number of places.
The secrecy of this “cryptosystem” relied on only Caesar and the recipients knowing a secret, the number of places by which Caesar had shifted his letters (e.g., 1). Not particularly secure by modern standards, but, hey, if you’re perhaps the first in the world to do it, pretty secure!
Unencrypted text is generally called plaintext. Encrypted text is generally called ciphertext. And the secret used is called a key.
To be clear, then, here’s how encrypting HELLO
with a key of \(1\) yields IFMMP
:
plaintext | H |
E |
L |
L |
O |
---|---|---|---|---|---|
+ key | \(1\) | \(1\) | \(1\) | \(1\) | \(1\) |
= ciphertext | I |
F |
M |
M |
P |
More formally, Caesar’s algorithm (i.e., cipher) encrypts messages by “rotating” each letter by \(k\) positions. More formally, if \(p\) is some plaintext (i.e., an unencrypted message), \(p_i\) is the \(i^{th}\) character in \(p\), and \(k\) is a secret key (i.e., a non-negative integer), then each letter, \(c_i\), in the ciphertext, \(c\), is computed as
\[c_i = (p_i + k) \% 26\]wherein \(\% 26\) here means “remainder when dividing by 26.” This formula perhaps makes the cipher seem more complicated than it is, but it’s really just a concise way of expressing the algorithm precisely. Indeed, for the sake of discussion, think of A (or a) as \(0\), B (or b) as \(1\), …, H (or h) as \(7\), I (or i) as \(8\), …, and Z (or z) as \(25\). Suppose that Caesar just wants to say Hi
to someone confidentially using, this time, a key, \(k\), of 3. And so his plaintext, \(p\), is Hi
, in which case his plaintext’s first character, \(p_0\), is H
(aka 7), and his plaintext’s second character, \(p_1\), is i
(aka 8). His ciphertext’s first character, \(c_0\), is thus K
, and his ciphertext’s second character, \(c_1\), is thus L
. Make sense?
Let’s write a program called caesar
that enables you to encrypt messages using Caesar’s cipher. At the time the user executes the program, they should decide, by providing a command-line argument, what the key should be in the secret message they’ll provide at runtime. We shouldn’t necessarily assume that the user’s key is going to be a number; though you may assume that, if it is a number, it will be a positive integer.
Here are a few examples of how the program might work. For example, if the user inputs a key of 1
and a plaintext of HELLO
:
$ ./caesar 1
plaintext: HELLO
ciphertext: IFMMP
Here’s how the program might work if the user provides a key of 13
and a plaintext of hello, world
:
$ ./caesar 13
plaintext: hello, world
ciphertext: uryyb, jbeyq
Notice that neither the comma nor the space were “shifted” by the cipher. Only rotate alphabetical characters!
How about one more? Here’s how the program might work if the user provides a key of 13
again, with a more complex plaintext:
$ ./caesar 13
plaintext: be sure to drink your Ovaltine
ciphertext: or fher gb qevax lbhe Binygvar
Why?
Notice that the case of the original message has been preserved. Lowercase letters remain lowercase, and uppercase letters remain uppercase.
And what if a user doesn’t cooperate, providing a command-line argument that isn’t a number? The program should remind the user how to use the program:
$ ./caesar HELLO
Usage: ./caesar key
Or really doesn’t cooperate, providing no command-line argument at all? The program should remind the user how to use the program:
$ ./caesar
Usage: ./caesar key
Or really, really doesn’t cooperate, providing more than one command-line argument? The program should remind the user how to use the program:
$ ./caesar 1 2 3
Usage: ./caesar key
Try It
To try out the staff’s implementation of this problem, execute
./caesar key
within this sandbox, substituting a valid integer in place of key
.
Specification
Design and implement a program, caesar
, that encrypts messages using Caesar’s cipher.
- Implement your program in a file called
caesar.c
in a directory calledcaesar
. - Your program must accept a single command-line argument, a non-negative integer. Let’s call it \(k\) for the sake of discussion.
- If your program is executed without any command-line arguments or with more than one command-line argument, your program should print an error message of your choice (with
printf
) and return frommain
a value of1
(which tends to signify an error) immediately. - If any of the characters of the command-line argument is not a decimal digit, your program should print the message
Usage: ./caesar key
and return frommain
a value of1
. - Do not assume that \(k\) will be less than or equal to 26. Your program should work for all non-negative integral values of \(k\) less than \(2^{31} - 26\). In other words, you don’t need to worry if your program eventually breaks if the user chooses a value for \(k\) that’s too big or almost too big to fit in an
int
. (Recall that anint
can overflow.) But, even if \(k\) is greater than \(26\), alphabetical characters in your program’s input should remain alphabetical characters in your program’s output. For instance, if \(k\) is \(27\),A
should not become[
even though[
is \(27\) positions away fromA
in ASCII, per asciichart.com;A
should becomeB
, sinceB
is \(27\) positions away fromA
, provided you wrap around fromZ
toA
. - Your program must output
plaintext:
(with two spaces but without a newline) and then prompt the user for astring
of plaintext (usingget_string
). - Your program must output
ciphertext:
(with one space but without a newline) followed by the plaintext’s corresponding ciphertext, with each alphabetical character in the plaintext “rotated” by k positions; non-alphabetical characters should be outputted unchanged. - Your program must preserve case: capitalized letters, though rotated, must remain capitalized letters; lowercase letters, though rotated, must remain lowercase letters.
- After outputting ciphertext, you should print a newline. Your program should then exit by returning
0
frommain
.
Advice
How to begin? Let’s approach this problem one step at a time.
Pseudocode
First write, try to write a main
function in caesar.c
that implements the program using just pseudocode, even if not (yet!) sure how to write it in actual code.
Hint
There’s more than one way to do this, so here’s just one!
int main(void)
{
// Make sure program was run with just one command-line argument
// Make sure every character in argv[1] is a digit
// Convert argv[1] from a `string` to an `int`
// Prompt user for plaintext
// For each character in the plaintext:
// Rotate the character if it's a letter
}
It’s okay to edit your own pseudocode after seeing ours here, but don’t simply copy/paste ours into your own!
Counting Command-Line Arguments
Whatever your pseudocode, let’s first write only the C code that checks whether the program was run with a single command-line argument before adding additional functionality.
Specifically, modify main
in caesar.c
in such a way that, if the user provides no command-line arguments, or two or more, the function prints "Usage: ./caesar key\n"
and then returns 1
, effectively exiting the program. If the user provides exactly one command-line argument, the program should print nothing and simply return 0
. The program should thus behave per the below.
$ ./caesar
Usage: ./caesar key
$ ./caesar 1 2 3
Usage: ./caesar key
$ ./caesar 1
Hints
- Recall that you can print with
printf
. - Recall that a function can return a value with
return
. - Recall that
argc
contains the number of command-line arguments passed to a program, plus the program’s own name.
Checking the Key
Now that your program is (hopefully!) accepting input as prescribed, it’s time for another step.
Add to caesar.c
, below main
, a function called, e.g., only_digits
that takes a string
as an argument and returns true
if that string
contains only digits, 0
through 9
, else it returns false
. Be sure to add the function’s prototype above main
as well.
Hints
- Odds are you’ll want a prototype like:
bool only_digits(string s);
And be sure to include
cs50.h
atop your file, so that the compiler recognizesstring
(andbool
). - Recall that a
string
is just an array ofchar
s. - Recall that
strlen
, declared instring.h
, calculates the length of astring
. - You might find
isdigit
, declared inctype.h
, to be helpful, per manual.cs50.io. But note that it only checks onechar
at a time!
Then modify main
in such a way that it calls only_digits
on argv[1]
. If that function returns false
, then main
should print "Usage: ./caesar key\n"
and return 1
. Else main
should simply return 0
. The program should thus behave per the below:
$ ./caesar 42
$ ./caesar banana
Usage: ./caesar key
Using the Key
Now modify main
in such a way that it converts argv[1]
to an int
. You might find atoi
, declared in stdlib.h
, to be helpful, per manual.cs50.io. And then use get_string
to prompt the user for some plaintext with "plaintext: "
.
Then, implement a function called, e.g., rotate
, that takes a char
as input and also an int
, and rotates that char
by that many positions if it’s a letter (i.e., alphabetical), wrapping around from Z
to A
(and from z
to a
) as needed. If the char
is not a letter, the function should instead return the same char
unchanged.
Hints
- Odds are you’ll want a prototype like:
char rotate(char c, int n);
A function call like
rotate('A', 1)
or even
rotate('A', 27)
should thus return
'B'
. And a function call likerotate('!', 13)
should return
'!'
. - Recall that you can explicitly “cast” a
char
to anint
with(char)
, and anint
to achar
with(int)
. Or you can do so implicitly by simply treating one as the other. - Odds are you’ll want to subtract the ASCII value of
'A'
from any uppercase letters, so as to treat'A'
as0
,'B'
as1
, and so forth, while performing arithmetic. And then add it back when done with the same. - Odds are you’ll want to subtract the ASCII value of
'a'
from any lowercase letters, so as to treat'a'
as0
,'b'
as1
, and so forth, while performing arithmetic. And then add it back when done with the same. - You might find some other functions declared in
ctype.h
to be helpful, per manual.cs50.io. - Odds are you’ll find
%
helpful when “wrapping around” arithmetically from a value like25
to0
.
Then modify main
in such a way that it prints "ciphertext: "
and then iterates over every char
in the user’s plaintext, calling rotate
on each, and printing the return value thereof.
Hints
- Recall that
printf
can print achar
using%c
. - If you’re not seeing any output at all when you call
printf
, odds are it’s because you’re printing characters outside of the valid ASCII range from 0 to 127. Try printing characters temporarily as numbers (using%i
instead of%c
) to see what values you’re printing!
Walkthrough
How to Test Your Code
Execute the below to evaluate the correctness of your code using check50
. But be sure to compile and test it yourself as well!
check50 cs50/problems/2022/spring/caesar
Execute the below to evaluate the style of your code using style50
.
style50 caesar.c
How to Submit
- Download your
caesar.c
file by control-clicking or right-clicking on the file in your codespace’s file browser and choosing Download. - Go to CS50’s Gradescope page.
- Click “Problem Set 2: Caesar”.
- Drag and drop your
caesar.c
file to the area that says “Drag & Drop”. Be sure it has that exact filename! If you upload a file with a different name, the autograder likely will fail when trying to run it, and ensuring you have uploaded files with the correct filename is your responsibility! - Click “Upload”.
You should see a message that says “Problem Set 2: Caesar submitted successfully!” You may not see a score just yet, but if you see the message then we’ve received your submission!